View Source RaftedValue.RPC.InstallSnapshotCompressed (rafted_value v0.11.2)
Link to this section Summary
Functions
Type-aware getter for bin.
Type-aware setter for bin.
Creates a new instance of RaftedValue.RPC.InstallSnapshotCompressed by using the given dict.
A variant of new/1 which returns t or raise if validation fails.
Updates an existing instance of RaftedValue.RPC.InstallSnapshotCompressed with the given dict.
The values in the dict are validated by each field's valid?/1 function.
Returns {:ok, valid_struct} or {:error, reason}.
A variant of update/2 which returns t or raise if validation fails.
In other words, update/2 followed by Croma.Result.get!/1.
Checks if the given value belongs to t/0 or not.
Link to this section Types
@type t() :: %RaftedValue.RPC.InstallSnapshotCompressed{bin: Croma.Binary.t()}
Link to this section Functions
@spec bin(t()) :: Croma.Binary.t()
Type-aware getter for bin.
@spec bin(t(), Croma.Binary.t()) :: t()
Type-aware setter for bin.
@spec new(term()) :: Croma.Result.t(t())
Creates a new instance of RaftedValue.RPC.InstallSnapshotCompressed by using the given dict.
Values associated with the struct field names are fetched from the given dict
and then validated/converted with valid?/1/new/1.
For missing fields default values (if any) are used.
Returns {:ok, valid_struct} when all fields are filled with valid values.
Returns {:error, reason} if any error occurs (invalid value or no value is available).
See also moduledoc of Croma.Struct.
A variant of new/1 which returns t or raise if validation fails.
In other words, new/1 followed by Croma.Result.get!/1.
@spec update(t(), Dict.t()) :: Croma.Result.t(t())
Updates an existing instance of RaftedValue.RPC.InstallSnapshotCompressed with the given dict.
The values in the dict are validated by each field's valid?/1 function.
Returns {:ok, valid_struct} or {:error, reason}.
A variant of update/2 which returns t or raise if validation fails.
In other words, update/2 followed by Croma.Result.get!/1.
Checks if the given value belongs to t/0 or not.