Enum PlaintextType 

pub enum PlaintextType<N: Network> {
    Literal(LiteralType),
    Struct(Identifier<N>),
    Array(ArrayType<N>),
}

A PlaintextType defines the type parameter for a literal, struct, or array.

Variants

Literal(LiteralType)

A literal type contains its type name. The format of the type is <type_name>.

Struct(Identifier<N>)

An struct type contains its identifier. The format of the type is <identifier>.

Array(ArrayType<N>)

An array type contains its element type and length. The format of the type is [<element_type>; <length>].

Implementations

impl<N: Network> PlaintextType<N>

pub fn size_in_bits<F>(&self, get_struct: &F) -> Result<usize>

where F: Fn(&Identifier<N>) -> Result<StructType<N>>,

Returns the number of bits of a plaintext type.

pub fn size_in_bits_raw<F>(&self, get_struct: &F) -> Result<usize>

where F: Fn(&Identifier<N>) -> Result<StructType<N>>,

Returns the number of raw bits of a plaintext type.

impl<N: Network> PlaintextType<N>

pub const ARRAY_PREFIX_BITS: [bool; 2]

pub const LITERAL_PREFIX_BITS: [bool; 2]

Prefix bits for (de)serializing the Literal variant.

pub const STRUCT_PREFIX_BITS: [bool; 2]

Prefix bits for (de)serializing the Struct variant.

pub fn exceeds_max_array_size(&self, max_array_size: u32) -> bool

Returns true if the plaintext type is an array and the size exceeds the given maximum.

Trait Implementations

impl<N: Clone + Network> Clone for PlaintextType<N>

fn clone(&self) -> PlaintextType<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N: Network> Debug for PlaintextType<N>

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

Prints the plaintext type as a string.

impl<'de, N: Network> Deserialize<'de> for PlaintextType<N>

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserializes the plaintext type from a string or bytes.

impl<N: Network> Display for PlaintextType<N>

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

Prints the plaintext type as a string.

impl<N: Network> From<ArrayType<N>> for PlaintextType<N>

fn from(array: ArrayType<N>) -> Self

Initializes a plaintext type from an array type.

impl<N: Network> From<Identifier<N>> for PlaintextType<N>

fn from(struct_: Identifier<N>) -> Self

Initializes a plaintext type from a struct type.

impl<N: Network> From<LiteralType> for PlaintextType<N>

fn from(literal: LiteralType) -> Self

Initializes a plaintext type from a literal type.

impl<N: Network> FromBytes for PlaintextType<N>

fn read_le<R: Read>(reader: R) -> IoResult<Self>

Reads a plaintext type from a buffer.

fn from_bytes_le(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Returns Self from a byte array in little-endian order.

fn from_bytes_le_unchecked(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Same behavior as Self::from_bytes_le but avoids costly checks. This shall only be called when deserializing from a trusted source, such as local storage.

fn read_le_unchecked<R>(reader: R) -> Result<Self, Error>

where R: Read, Self: Sized,

Same behavior as Self::read_le but avoids costly checks. This shall only be called when deserializing from a trusted source, such as local storage.

fn read_le_with_unchecked<R>(reader: R, unchecked: bool) -> Result<Self, Error>

where R: Read, Self: Sized,

Helper function that deserializes either unchecked or checked based on the given boolean flag.

impl<N: Network> FromStr for PlaintextType<N>

fn from_str(string: &str) -> Result<Self>

Returns a plaintext type from a string literal.

type Err = Error

The associated error which can be returned from parsing.

impl<N: Hash + Network> Hash for PlaintextType<N>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<N: Network> Parser for PlaintextType<N>

fn parse(string: &str) -> ParserResult<'_, Self>

Parses a string into a plaintext type.

impl<N: PartialEq + Network> PartialEq for PlaintextType<N>

fn eq(&self, other: &PlaintextType<N>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<N: Network> Serialize for PlaintextType<N>

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serializes the plaintext type into string or bytes.

impl<N: Network> ToBytes for PlaintextType<N>

fn write_le<W: Write>(&self, writer: W) -> IoResult<()>

Writes a plaintext type to a buffer.

fn to_bytes_le(&self) -> Result<Vec<u8>, Error>

where Self: Sized,

Returns self as a byte array in little-endian order.

impl<N: Eq + Network> Eq for PlaintextType<N>

impl<N: Network> StructuralPartialEq for PlaintextType<N>