suica/jxl/container does not have a README file

    BitstreamKind

    pub(all) enum BitstreamKind {
    Unknown
    BareCodestream
    Container
    Invalid
    } derive(Eq,
    Debug
    )

    Structure of the decoded bitstream.

    ContainerBoxHeader

    pub(all) struct ContainerBoxHeader {
    ty : ContainerBoxType
    box_size : UInt64?
    is_last : Bool
    } derive(
    Debug
    )

    Box header used in JPEG XL containers.

    ContainerBoxHeader::box_size

    fn ContainerBoxHeader::box_size(self : ContainerBoxHeader) -> UInt64?

    ContainerBoxHeader::box_type

    ContainerBoxHeader::is_last

    fn ContainerBoxHeader::is_last(self : ContainerBoxHeader) -> Bool

    ContainerBoxHeader::parse

    ContainerBoxType

    pub(all) struct ContainerBoxType(Bytes) derive(Eq, Hash,
    Debug
    )

    Type of JPEG XL container box (four-character code).

    Known types are available as static functions (ContainerBoxType::codestream(), ...).

    ContainerBoxType::brotli_compressed

    fn ContainerBoxType::brotli_compressed() -> ContainerBoxType

    Brotli-compressed box.

    ContainerBoxType::bytes

    fn ContainerBoxType::bytes(self : ContainerBoxType) -> Bytes

    The four bytes of the box type.

    ContainerBoxType::codestream

    JPEG XL codestream box.

    ContainerBoxType::exif

    Exif box.

    ContainerBoxType::file_type

    JPEG XL file type box.

    ContainerBoxType::frame_index

    fn ContainerBoxType::frame_index() -> ContainerBoxType

    Frame index box.

    ContainerBoxType::hdr_gain_map

    fn ContainerBoxType::hdr_gain_map() -> ContainerBoxType

    HDR gain map box.

    ContainerBoxType::jpeg_reconstruction

    fn ContainerBoxType::jpeg_reconstruction() -> ContainerBoxType

    JPEG bistream reconstruction data box.

    ContainerBoxType::jumbf

    JUMBF box.

    ContainerBoxType::jxl

    JPEG XL signature box.

    ContainerBoxType::jxl_level

    JPEG XL level box.

    ContainerBoxType::partial_codestream

    fn ContainerBoxType::partial_codestream() -> ContainerBoxType

    JPEG XL partial codestream box.

    ContainerBoxType::xml

    XML box, mainly for storing XMP metadata.

    ContainerParser

    pub struct ContainerParser {
    // private fields
    }

    Parser that detects the kind of bitstream and emits parser events.

    ContainerParser::feed_bytes

    fn ContainerParser::feed_bytes(self : ContainerParser, input : BytesView) -> ParseEvents

    Feeds bytes to the parser, and receives parser events.

    The parser might not consume all of the buffer. Use previous_consumed_bytes to get how many bytes are consumed. Bytes not consumed by the parser should be fed into the parser again.

    ContainerParser::kind

    Returns the kind of this bitstream currently recognized.

    ContainerParser::new

    Creates a new parser.

    ContainerParser::previous_consumed_bytes

    fn ContainerParser::previous_consumed_bytes(self : ContainerParser) -> Int

    Get how many bytes are consumed by the previous call to feed_bytes.

    Bytes not consumed by the parser should be fed into the parser again.

    HeaderParseResult

    pub(all) enum HeaderParseResult {
    Done(header~ : ContainerBoxHeader, header_size~ : Int)
    NeedMoreData
    } derive(
    Debug
    )

    Result of parsing container box header.

    ParseEvent

    pub(all) enum ParseEvent {
    BitstreamKind(BitstreamKind)
    Codestream(BytesView)
    NoMoreAuxBox
    AuxBoxStart(ty~ : ContainerBoxType, brotli_compressed~ : Bool, last_box~ : Bool)
    AuxBoxData(ContainerBoxType, BytesView)
    AuxBoxEnd(ContainerBoxType)
    }

    Parser event emitted by ParseEvents.
    impl Show for ParseEvent

    ParseEvents

    pub struct ParseEvents {
    // private fields
    }

    Iterator that reads over a buffer and emits parser events.

    ParseEvents::next

    Returns the next parser event, or None when the parser needs more input (or the input is exhausted).

    codestream_sig

    let codestream_sig : Bytes

    JPEG XL bare codestream signature, ff 0a.

    container_sig

    let container_sig : Bytes

    JPEG XL container format signature, 00 00 00 0c 4a 58 4a 20 0d 0a 87 0a.