libxml2-wasm
    Preparing search index...

    Interface XmlInputProviderAlpha

    The input provider for Virtual IO.

    This interface defines four callbacks for reading the content of XML files. Each callback takes a 4-byte integer as the type of file descriptor.

    xmlRegisterInputProvider

    interface XmlInputProvider {
        close: (fd: number) => boolean;
        match: (filename: string) => boolean;
        open: (filename: string) => number | undefined;
        read: (fd: number, buf: Uint8Array) => number;
    }

    Implemented by

    Index

    Properties

    close match open read

    Properties

    close: (fd: number) => boolean

    Close the file.

    Type Declaration

      • (fd: number): boolean

      • Parameters

        • fd: number

          File descriptor

        Returns boolean

        true if succeeded.

    match: (filename: string) => boolean

    Determine if this input provider should handle this file.

    Type Declaration

      • (filename: string): boolean

      • Parameters

        • filename: string

          The file name/path/url

        Returns boolean

        true if the provider should handle it.

    open: (filename: string) => number | undefined

    Open the file and return a file descriptor (handle) representing the file.

    Type Declaration

      • (filename: string): number | undefined

      • Parameters

        • filename: string

          The file name/path/url

        Returns number | undefined

        undefined on error, number on success.

    read: (fd: number, buf: Uint8Array) => number

    Read from the file.

    Type Declaration

      • (fd: number, buf: Uint8Array): number

      • Parameters

        • fd: number

          File descriptor

        • buf: Uint8Array

          Buffer to read into, with a maximum read size of its byteLength.

        Returns number

        number of bytes actually read, -1 on error.

    Settings

    Member Visibility

    On This Page

    Properties