Struct bc_envelope::base::assertion::Assertion

pub struct Assertion { /* private fields */ }

Represents an assertion.

Generally you do not create an instance of this type directly, but instead use Envelope::new_assertion, or the various functions on Envelope that create assertions.

Implementations

impl Assertion

pub fn new( predicate: impl EnvelopeEncodable, object: impl EnvelopeEncodable ) -> Self

Creates an assertion and calculates its digest.

pub fn predicate(&self) -> Envelope

Returns the predicate of the assertion.

pub fn object(&self) -> Envelope

Returns the object of the assertion.

pub fn digest_ref(&self) -> &Digest

Returns the digest of the assertion.

impl Assertion

pub fn new_attachment<A>( payload: A, vendor: &str, conforms_to: Option<&str> ) -> Self

where A: EnvelopeEncodable,

Creates an attachment assertion. See: BCR-2023-006

pub fn attachment_payload(&self) -> Result<Envelope, EnvelopeError>

Returns the payload of the given attachment assertion.

pub fn attachment_vendor(&self) -> Result<String>

Returns the vendor of the given attachment assertion.

pub fn attachment_conforms_to(&self) -> Result<Option<String>>

Returns the conformsTo of the given attachment assertion.

pub fn validate_attachment(&self) -> Result<()>

Validates the given attachment assertion.

Ensures:

• The attachment assertion’s predicate is known_values::ATTACHMENT.
• The attachment assertion’s object is an envelope.
• The attachment assertion’s object has a 'vendor': String assertion.
• The attachment assertion’s object has an optional 'conformsTo': String assertion.

Trait Implementations

impl CBORDecodable for Assertion

fn from_cbor(cbor: &CBOR) -> Result<Self>

Creates an instance of this type from CBOR symbolic representation.

fn from_cbor_data(cbor_data: &[u8]) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type from encoded CBOR binary data.

impl CBOREncodable for Assertion

fn cbor(&self) -> CBOR

Returns the value in CBOR symbolic representation.

fn cbor_data(&self) -> Vec<u8>

Returns the value in CBOR binary representation.

impl Clone for Assertion

fn clone(&self) -> Assertion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Assertion

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

Formats the value using the given formatter.

impl DigestProvider for Assertion

fn digest(&self) -> Cow<'_, Digest>

impl EnvelopeEncodable for Assertion

fn envelope(self) -> Envelope

impl EnvelopeFormat for Assertion

fn format_item(&self, context: &FormatContext) -> EnvelopeFormatItem

impl From<Assertion> for CBOR

fn from(value: Assertion) -> Self

Converts to this type from the input type.

impl From<Assertion> for Envelope

fn from(assertion: Assertion) -> Self

Converts to this type from the input type.

impl PartialEq for Assertion

fn eq(&self, other: &Self) -> 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 TryFrom<CBOR> for Assertion

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: CBOR) -> Result<Self, Self::Error>

Performs the conversion.

impl CBORCodable for Assertion

impl Eq for Assertion