Skip to main content

Packet

Struct Packet 

Source
pub struct Packet(/* private fields */);
Expand description

One sealed packet: an ordered list of units, rooted in a predecessor.

Identity is over the whole node — payload and parent links together — so a packet cannot be re-parented without changing its id.

Implementations§

Source§

impl Packet

Source

pub fn genesis(units: Vec<UnitId>) -> Self

A packet with no predecessor.

Source

pub fn following(prior: PacketId, units: Vec<UnitId>) -> Self

A packet linking prior as its predecessor.

Source

pub fn units(&self) -> &[UnitId]

The units this packet seals, in order.

Source

pub fn parents(&self) -> &BTreeSet<ContentId>

The predecessor links.

Source

pub fn prior(&self) -> Option<PacketId>

The single predecessor, when there is exactly one.

v0 mints chains, so a packet has zero parents (genesis) or one.

Source

pub fn is_genesis(&self) -> bool

Whether this packet starts a chain.

Source

pub fn id(&self) -> Result<PacketId, ContentError>

This packet’s address.

§Errors

Propagates an encoding failure from the canonical form.

Trait Implementations§

Source§

impl Clone for Packet

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl ContentAddressable for Packet

Source§

fn canonical_form(&self) -> Result<Vec<u8>, ContentError>

Produce the deterministic byte representation of this value. Read more
Source§

fn content_id(&self) -> Result<ContentId, ContentError>

Compute this value’s ContentId. Read more
Source§

fn verify(&self, expected: &ContentId) -> Result<bool, ContentError>

Check whether this value’s content id matches an expected id. Read more
Source§

fn ensure_content_id(&self, expected: &ContentId) -> Result<(), ContentError>

Verify, returning an error on mismatch instead of Ok(false). Read more
Source§

impl Debug for Packet

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Packet

Source§

impl PartialEq for Packet

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for Packet

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Packet

Source§

impl TryFrom<MerkleNode<PacketBody>> for Packet

Source§

fn try_from(raw: RawPacket) -> Result<Self, Self::Error>

The only way in from foreign bytes.

One rule, because the chain has one shape: at most one parent. Nothing else about a decoded packet is a claim this layer can check — whether the units it names exist, or admit, needs a store, and inventing one here would be v0 growing a storage service to answer a structural question.

§Errors

PacketAdmitError::NotAChain when the node carries two or more parents.

Source§

type Error = PacketAdmitError

The type returned in the event of a conversion error.

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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<T> ToOwned for T
where T: Clone,

Source§

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<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.