Struct bp7::bundle::Bundle

pub struct Bundle {
    pub primary: PrimaryBlock,
    pub canonicals: Vec<CanonicalBlock>,
}

Bundle represents a bundle as defined in section 4.2.1. Each Bundle contains one primary block and multiple canonical blocks.

Fields

primary: PrimaryBlock

canonicals: Vec<CanonicalBlock>

Implementations

impl Bundle

pub fn new(primary: PrimaryBlock, canonicals: Vec<CanonicalBlock>) -> Bundle

pub fn validate(&self) -> Result<(), ErrorList>

Validate bundle and optionally return list of errors.

pub fn sort_canonicals(&mut self)

Sort canonical blocks by block number

pub fn add_canonical_block(&mut self, cblock: CanonicalBlock)

Automatically assign a block number and add canonical block to bundle

pub fn is_administrative_record(&self) -> bool

Checks whether the bundle is an administrative record

pub fn payload(&self) -> Option<&ByteBuffer>

Return payload of bundle if an payload block exists and carries data.

pub fn set_payload_block(&mut self, payload: CanonicalBlock)

Sets or updates the payload block

pub fn set_payload(&mut self, payload: ByteBuffer)

Sets or updates the payload

pub fn set_crc(&mut self, crc_type: CrcRawType)

Sets the given CRCType for each block. The crc value is calculated on-the-fly before serializing.

pub fn crc_valid(&mut self) -> bool

Check whether a bundle has only valid CRC checksums in all blocks.

pub fn calculate_crc(&mut self)

Calculate crc for all blocks.

pub fn extension_block_by_type( &self, block_type: CanonicalBlockType ) -> Option<&CanonicalBlock>

Get first extension block matching the block type

pub fn extension_block_by_type_mut( &mut self, block_type: CanonicalBlockType ) -> Option<&mut CanonicalBlock>

Get mutable reference for first extension block matching the block type

pub fn to_cbor(&mut self) -> ByteBuffer

Serialize bundle as CBOR encoded byte buffer.

pub fn to_json(&mut self) -> String

Serialize bundle as JSON encoded string.

pub fn id(&self) -> String

ID returns a kind of uniquene representation of this bundle, containing the souce node and creation timestamp. If this bundle is a fragment, the offset is also present.

pub fn update_extensions( &mut self, local_node: EndpointID, residence_time: u128 ) -> bool

Update extension blocks such as hop count, bundle age and previous node. Return true if all successful, omit missing blocks. Return false if hop count is exceeded, bundle age exceeds life time or bundle lifetime itself is exceeded

pub fn previous_node(&self) -> Option<&EndpointID>

Return the previous node of a bundle should a Previous Node Block exist

Trait Implementations

impl Clone for Bundle

fn clone(&self) -> Bundle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bundle

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

Formats the value using the given formatter.

impl Default for Bundle

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Bundle

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Bundle

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

Formats the value using the given formatter.

impl PartialEq for Bundle

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

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

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.

impl Serialize for Bundle

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for Bundle

Deserialize from CBOR byte slice.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(item: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for Bundle

Deserialize from JSON string.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(item: String) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for Bundle

Deserialize from CBOR byte buffer.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(item: ByteBuffer) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Bundle