Interface XmlInputProviderAlpha

The input provider for Virtual IO.

This interface defines 4 callbacks for reading content of xml, where 4-bytes integer is used as the type of file descriptor.

See

xmlRegisterInputProvider

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

Methods

close match open read

Methods

close

  • close(fd): boolean
  • Alpha

    Close the file

    Parameters

    • fd: number

      file descriptor

    Returns boolean

    true if success

match

  • match(filename): boolean
  • Alpha

    Check if this input provider should handle this file

    Parameters

    • filename: string

      The file name/path/url

    Returns boolean

    true if the provider should handle

open

  • open(filename): undefined | number
  • Alpha

    Open the file and return a file descriptor (handle)

    Parameters

    • filename: string

      file path

    Returns undefined | number

    undefined on error, FdType on success

read

  • read(fd, buf): number
  • Alpha

    Read from a file

    Parameters

    • fd: number

      File descriptor

    • buf: Uint8Array

      Buffer to read into, no more than its byteLength shall be read into.

    Returns number

    number of bytes actually read, -1 on error

Settings

Member Visibility

On This Page

Methods