View Source Evision.IStreamReader (Evision v0.2.17-rc1)

Summary

Types

t()

Type that represents an IStreamReader struct.

Functions

read(named_args)
read(self, buffer, size)

Read bytes from stream

seek(named_args)
seek(self, offset, origin)

Sets the stream position

Types

Link to this type

t()

View Source 
@type t() :: %Evision.IStreamReader{ref: reference()}

Type that represents an IStreamReader struct.

  • ref. reference()

    The underlying erlang resource variable.

Functions

Link to this function

read(named_args)

View Source 
@spec read(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

read(self, buffer, size)

View Source 
@spec read(t(), binary(), integer()) :: integer() | {:error, String.t()}

Read bytes from stream

Positional Arguments

  • self: Evision.IStreamReader.t()

  • buffer: c_string.

    already allocated buffer of at least @p size bytes

  • size: long long.

    maximum number of bytes to read

Return
  • retval: long long

@return actual number of read bytes

Python prototype (for reference only):

read(buffer, size) -> retval
Link to this function

seek(named_args)

View Source 
@spec seek(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

seek(self, offset, origin)

View Source 
@spec seek(t(), integer(), integer()) :: integer() | {:error, String.t()}

Sets the stream position

Positional Arguments

  • self: Evision.IStreamReader.t()

  • offset: long long.

    Seek offset

  • origin: integer().

    SEEK_SET / SEEK_END / SEEK_CUR

Return
  • retval: long long

@see fseek

Python prototype (for reference only):

seek(offset, origin) -> retval