GitHub

API reference for etag.

Entity tags (Effect's Etag): Weak / Strong values and the Generator service that makes them for files.

Values

AttributeTypeDescription
layerLayer[Generator]

Strong tags.

layer_weakLayer[Generator]

Weak tags.

Types

TypeDefinitionDescription
Etagtype Etag = Weak | Strong

Classes

Functions

to_string

to_string(etag) -> str

The header value: W/"value" or "value".

ParameterTypeDescription
etagEtag

Returns str

def to_string(etag: Etag) -> str:
    """The header value: ``W/"value"`` or ``"value"``."""
    match etag:
        case Weak(value):
            return f'W/"{value}"'
        case Strong(value):
            return f'"{value}"'

value_from_file_info

value_from_file_info(info) -> str

<size>-<mtime ms> in hex (0 without an mtime).

ParameterTypeDescription
infoFileInfo

Returns str

def value_from_file_info(info: FileInfo) -> str:
    """``<size>-<mtime ms>`` in hex (``0`` without an mtime)."""
    mtime = "0" if info.mtime is None else format(_milliseconds(info.mtime), "x")
    return f"{int(info.size):x}-{mtime}"

value_from_file_web

value_from_file_web(file) -> str
ParameterTypeDescription
fileFileLike

Returns str

def value_from_file_web(file: FileLike) -> str:
    return f"{file.size:x}-{_milliseconds(file.last_modified):x}"