Struct VirtualClientCommitData 

pub struct VirtualClientCommitData { /* private fields */ }

Available on crate feature extensions-draft and crate feature virtual-clients-draft and (32-bit or 64-bit) only.

What a virtual client tells its siblings about a commit it authored.

Implementations

impl VirtualClientCommitData

pub fn new( epoch_usage: Option<VcEpochUsage>, actions: Vec<VirtualClientAction>, ) -> Result<Self, VcCommitDataError>

Assemble the commit data.

Pass None for epoch_usage to leave the author’s previous declaration in place, and Some(VcEpochUsage::empty()) to replace it with the empty set.

Returns an error if actions holds more than one VirtualClientAction::NewDerivationEpoch.

pub fn epoch_usage(&self) -> Option<&VcEpochUsage>

The author’s epoch usage declaration, or None if the commit does not restate it.

pub fn actions(&self) -> &[VirtualClientAction]

All actions the commit performs.

pub fn creates_derivation_epoch(&self) -> bool

Returns true if the commit asks for a new derivation epoch.

pub fn key_package_uploads(&self) -> impl Iterator<Item = &KeyPackageUpload>

The KeyPackage batches the commit publishes, in wire order.

pub fn to_safe_aad_item(&self) -> Result<SafeAadItem, VcCommitDataError>

Wrap this commit data in a Safe AAD item tagged with VC_COMPONENT_ID, ready to be attached to an outgoing commit.

pub fn from_safe_aad_item_data(data: &[u8]) -> Result<Self, VcCommitDataError>

Parse commit data from the bytes of a Safe AAD item tagged with VC_COMPONENT_ID. Rejects bytes left over after the struct.

Trait Implementations

impl Debug for VirtualClientCommitData

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

Formats the value using the given formatter.

impl DeserializeBytes for VirtualClientCommitData

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

This function deserializes the bytes from the provided a &[u8] and returns the populated struct, as well as the remaining slice.

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

where Self: Sized,

This function deserializes the provided bytes and returns the populated struct. All bytes must be consumed.

impl PartialEq for VirtualClientCommitData

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for VirtualClientCommitData

fn tls_serialize<W: Write>(&self, writer: &mut W) -> Result<usize, Error>

Available on crate feature std only.

Serialize self and write it to the writer. The function returns the number of bytes written to writer.

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

Available on crate feature std only.

Serialize self and return it as a byte vector.

impl Serialize for &VirtualClientCommitData

fn tls_serialize<W: Write>(&self, writer: &mut W) -> Result<usize, Error>

Available on crate feature std only.

Serialize self and write it to the writer. The function returns the number of bytes written to writer.

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

Available on crate feature std only.

Serialize self and return it as a byte vector.

impl Size for VirtualClientCommitData

fn tls_serialized_len(&self) -> usize

impl Size for &VirtualClientCommitData

fn tls_serialized_len(&self) -> usize

impl StructuralPartialEq for VirtualClientCommitData