Struct iota_client::block::payload::MilestonePayload

source · [−]

pub struct MilestonePayload { /* private fields */ }

Expand description

A payload which defines the inclusion set of other blocks in the Tangle.

Implementations

source

impl MilestonePayload

source

pub const KIND: u32 = 7u32

The payload kind of a MilestonePayload.

source

pub const SIGNATURE_COUNT_RANGE: RangeInclusive<u8> = #[lang = "range_inclusive_new"](1, 255)

Range of allowed milestones signatures key numbers.

source

pub const SIGNATURE_LENGTH: usize = 64usize

Length of a milestone signature.

source

pub fn new(
essence: MilestoneEssence,
signatures: Vec<Signature, Global>
) -> Result<MilestonePayload, Error>

Creates a new MilestonePayload.

source

pub fn essence(&self) -> &MilestoneEssence

Returns the essence of a MilestonePayload.

source

pub fn signatures(&self) -> &[Signature]

Returns the signatures of a MilestonePayload.

source

pub fn id(&self) -> MilestoneId

Computes the identifier of a MilestonePayload.

source

pub fn validate(
 &self,
 applicable_public_keys: &[String],
 min_threshold: usize
) -> Result<(), MilestoneValidationError>

Semantically validate a MilestonePayload.

source

impl MilestonePayload

source

pub fn try_from_dto(
value: &MilestonePayloadDto,
protocol_parameters: &ProtocolParameters
) -> Result<MilestonePayload, DtoError>

source

pub fn try_from_dto_unverified(
value: &MilestonePayloadDto
) -> Result<MilestonePayload, DtoError>

Trait Implementations

source

impl Clone for MilestonePayload

source

fn clone(&self) -> MilestonePayload

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for MilestonePayload

source

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

Formats the value using the given formatter. Read more

source

impl<'de> Deserialize<'de> for MilestonePayload

source

fn deserialize<D>(
deserializer: D
) -> Result<MilestonePayload, <D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

impl From<&MilestonePayload> for MilestonePayloadDto

source

fn from(value: &MilestonePayload) -> MilestonePayloadDto

Converts to this type from the input type.

source

impl From<MilestonePayload> for Payload

source

fn from(payload: MilestonePayload) -> Payload

Converts to this type from the input type.

source

impl Packable for MilestonePayload

type UnpackError = Error

The error type that can be returned if some semantic error occurs while unpacking. Read more

type UnpackVisitor = ProtocolParameters

FIXME: docs

source

fn pack(&self, packer: &mut P) -> Result<(), ::Error>where
P: Packer,

Packs this value into the given Packer.

source

fn unpack<U, const VERIFY: bool>(
 unpacker: &mut U,
 visitor: &<MilestonePayload as Packable>::UnpackVisitor
) -> Result<MilestonePayload, UnpackError<<MilestonePayload as Packable>::UnpackError, ::Error>>where
 U: Unpacker,

Unpacks this value from the given Unpacker. The VERIFY generic parameter can be used to skip additional syntactic checks. Read more

source

impl PartialEq<MilestonePayload> for MilestonePayload

source

fn eq(&self, other: &MilestonePayload) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

impl Serialize for MilestonePayload

source

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

Serialize this value into the given Serde serializer. Read more

source

impl Eq for MilestonePayload

source

impl StructuralEq for MilestonePayload

source

impl StructuralPartialEq for MilestonePayload

Auto Trait Implementations

impl RefUnwindSafe for MilestonePayload

impl Send for MilestonePayload

impl Sync for MilestonePayload

impl Unpin for MilestonePayload

impl UnwindSafe for MilestonePayload

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl PackableExt for Pwhere
P: Packable,

source

fn unpack_verified<T>(
 bytes: T,
 visitor: &::UnpackVisitor
) -> Result<P, UnpackError<::UnpackError, UnexpectedEOF>>where
 T: AsRef<[u8]>,

Unpacks this value from a type that implements [AsRef<[u8]>].

source

fn unpack_unverified<T>(
bytes: T
) -> Result<P, UnpackError<::UnpackError, UnexpectedEOF>>where
T: AsRef<[u8]>,

Unpacks this value from a type that implements [AsRef<[u8]>] skipping some syntatical checks.

source

fn packed_len(&self) -> usize

Returns the length in bytes of the value after being packed. The returned value always matches the number of bytes written using pack. Read more

source

fn pack_to_vec(&self) -> Vec<u8, Global>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A>where A: Allocator,`

Convenience method that packs this value into a Vec<u8>.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

source

Struct iota_client::block::payload::MilestonePayload

Implementations

impl MilestonePayload

pub const KIND: u32 = 7u32

pub const SIGNATURE_COUNT_RANGE: RangeInclusive<u8> = #[lang = "range_inclusive_new"](1, 255)

pub const SIGNATURE_LENGTH: usize = 64usize

pub fn new( essence: MilestoneEssence, signatures: Vec<Signature, Global>) -> Result<MilestonePayload, Error>

pub fn essence(&self) -> &MilestoneEssence

pub fn signatures(&self) -> &[Signature]

pub fn id(&self) -> MilestoneId

pub fn validate( &self, applicable_public_keys: &[String], min_threshold: usize) -> Result<(), MilestoneValidationError>

impl MilestonePayload

pub fn try_from_dto( value: &MilestonePayloadDto, protocol_parameters: &ProtocolParameters) -> Result<MilestonePayload, DtoError>

pub fn try_from_dto_unverified( value: &MilestonePayloadDto) -> Result<MilestonePayload, DtoError>

Trait Implementations

impl Clone for MilestonePayload

fn clone(&self) -> MilestonePayload

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

impl Debug for MilestonePayload

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

impl<'de> Deserialize<'de> for MilestonePayload

fn deserialize<__D>( __deserializer: __D) -> Result<MilestonePayload, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

impl From<&MilestonePayload> for MilestonePayloadDto

fn from(value: &MilestonePayload) -> MilestonePayloadDto

impl From<MilestonePayload> for Payload

fn from(payload: MilestonePayload) -> Payload

impl Packable for MilestonePayload

type UnpackError = Error

type UnpackVisitor = ProtocolParameters

fn pack<P>(&self, packer: &mut P) -> Result<(), <P as Packer>::Error>where P: Packer,

fn unpack<U, const VERIFY: bool>( unpacker: &mut U, visitor: &<MilestonePayload as Packable>::UnpackVisitor) -> Result<MilestonePayload, UnpackError<<MilestonePayload as Packable>::UnpackError, <U as Unpacker>::Error>>where U: Unpacker,

impl PartialEq<MilestonePayload> for MilestonePayload

fn eq(&self, other: &MilestonePayload) -> bool

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

impl Serialize for MilestonePayload

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

impl Eq for MilestonePayload

impl StructuralEq for MilestonePayload

impl StructuralPartialEq for MilestonePayload

Auto Trait Implementations

impl RefUnwindSafe for MilestonePayload

impl Send for MilestonePayload

impl Sync for MilestonePayload

impl Unpin for MilestonePayload

impl UnwindSafe for MilestonePayload

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<P> PackableExt for Pwhere P: Packable,

fn unpack_verified<T>( bytes: T, visitor: &<P as Packable>::UnpackVisitor) -> Result<P, UnpackError<<P as Packable>::UnpackError, UnexpectedEOF>>where T: AsRef<[u8]>,

fn unpack_unverified<T>( bytes: T) -> Result<P, UnpackError<<P as Packable>::UnpackError, UnexpectedEOF>>where T: AsRef<[u8]>,

fn packed_len(&self) -> usize

fn pack_to_vec(&self) -> Vec<u8, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A>where A: Allocator,

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

fn vzip(self) -> V

pub fn new(
essence: MilestoneEssence,
signatures: Vec<Signature, Global>
) -> Result<MilestonePayload, Error>

pub fn validate(
&self,
applicable_public_keys: &[String],
min_threshold: usize
) -> Result<(), MilestoneValidationError>

pub fn try_from_dto(
value: &MilestonePayloadDto,
protocol_parameters: &ProtocolParameters
) -> Result<MilestonePayload, DtoError>

pub fn try_from_dto_unverified(
value: &MilestonePayloadDto
) -> Result<MilestonePayload, DtoError>

fn deserialize<D>(
deserializer: D
) -> Result<MilestonePayload, <D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,

fn pack<P>(&self, packer: &mut P) -> Result<(), <P as Packer>::Error>where
P: Packer,

fn unpack<U, const VERIFY: bool>(
unpacker: &mut U,
visitor: &<MilestonePayload as Packable>::UnpackVisitor
) -> Result<MilestonePayload, UnpackError<<MilestonePayload as Packable>::UnpackError, <U as Unpacker>::Error>>where
U: Unpacker,

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

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<P> PackableExt for Pwhere
P: Packable,

fn unpack_verified<T>(
bytes: T,
visitor: &<P as Packable>::UnpackVisitor
) -> Result<P, UnpackError<<P as Packable>::UnpackError, UnexpectedEOF>>where
T: AsRef<[u8]>,

fn unpack_unverified<T>(
bytes: T
) -> Result<P, UnpackError<<P as Packable>::UnpackError, UnexpectedEOF>>where
T: AsRef<[u8]>,

fn pack_to_vec(&self) -> Vec<u8, Global>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A>where A: Allocator,`

impl<T> ToOwned for Twhere
T: Clone,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,

impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,