brotli_encoder (brotli v0.3.3)

View Source

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)

Types

mode/0

-type mode() :: generic | text | font.

ndirect/0

-type ndirect() :: non_neg_integer().

options/0

-type 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()}.

t/0

-opaque t()

Functions

append(Encoder, Data)

-spec append(Encoder :: t(), Data :: iodata()) -> {ok, iodata()} | error.

finish(Encoder)

-spec finish(Encoder :: t()) -> {ok, iodata()} | error.

finish(Encoder, Data)

-spec finish(Encoder :: t(), Data :: iodata()) -> {ok, iodata()} | error.

is_finished(Encoder)

-spec is_finished(Encoder :: t()) -> boolean().

new()

-spec new() -> t().

new(Opts)

-spec new(Opts :: options()) -> t().

set_opts(Encoder, Opts)

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