Struct RevealParams 

#[non_exhaustive]
pub struct RevealParams {
    pub message: String,
    pub format: Option<RevealFormat>,
    pub note: Option<String>,
    pub length: Option<u64>,
}

Params for reveal action.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

message: String

What the value is and what to do with it, shown above it and printed on the sheet.

format: Option<RevealFormat>

The encoding: paper32 (the default), hex, or bip39 for a wallet’s recovery phrase.

note: Option<String>

Text printed on the sheet: where it goes, who keeps it.

length: Option<u64>

The value’s length in the format’s unit, words for bip39 and bytes otherwise, when the author knows it, so the sheet has exactly the right number of rows; a value of another size is refused. A share counts the three header bytes in front of its secret.

Trait Implementations

impl Clone for RevealParams

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RevealParams

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RevealParams

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RevealParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for RevealParams

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for RevealParams

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.