brotli v0.3.1

brotli_encoder (brotli v0.3.1) View Source

Link to this section Summary

Types

mode/0
ndirect/0
options/0
t/0

Functions

append(Encoder, Data)
finish(Encoder)
finish(Encoder, Data)
is_finished(Encoder)
new()
new(Opts)
set_opts(Encoder, Opts)

Link to this section Types

Link to this type

mode/0

View Source

Specs

mode() :: generic | text | font.
Link to this type

ndirect/0

View Source

Specs

ndirect() :: non_neg_integer().
Link to this type

options/0

View Source

Specs

options() ::
    #{mode => mode(),
      quality => 0..11,
      window => 10..30,
      block_size => 16..24,
      literal_context_modeling => boolean(),
      size_hint => non_neg_integer(),
      large_window => boolean(),
      npostfix => 0..3,
      ndirect => ndirect(),
      stream_offset => non_neg_integer()}.
Link to this opaque

t/0

View Source (opaque)

Specs

t()

Link to this section Functions

Link to this function

append(Encoder, Data)

View Source

Specs

append(Encoder :: t(), Data :: iodata()) -> {ok, iodata()} | error.
Link to this function

finish(Encoder)

View Source

Specs

finish(Encoder :: t()) -> {ok, iodata()} | error.
Link to this function

finish(Encoder, Data)

View Source

Specs

finish(Encoder :: t(), Data :: iodata()) -> {ok, iodata()} | error.
Link to this function

is_finished(Encoder)

View Source

Specs

is_finished(Encoder :: t()) -> boolean().
Link to this function

new()

View Source

Specs

new() -> t().
Link to this function

new(Opts)

View Source

Specs

new(Opts :: options()) -> t().
Link to this function

set_opts(Encoder, Opts)

View Source

Specs

set_opts(Encoder :: t(), Opts :: options()) -> ok.