Skip to main content

Envelope

starweft_protocol

Struct Envelope

pub struct Envelope<T> {Show 13 fields
    pub protocol: String,
    pub msg_id: MessageId,
    pub msg_type: MsgType,
    pub from_actor_id: ActorId,
    pub to_actor_id: Option<ActorId>,
    pub vision_id: Option<VisionId>,
    pub project_id: Option<ProjectId>,
    pub task_id: Option<TaskId>,
    pub lamport_ts: u64,
    pub created_at: OffsetDateTime,
    pub expires_at: Option<OffsetDateTime>,
    pub body: T,
    pub signature: MessageSignature,
}

Expand description

A signed envelope carrying a typed message body.

Fields§

§protocol: String

Protocol version string.

§msg_id: MessageId

Unique message identifier.

§msg_type: MsgType

Type discriminator matching the body.

§from_actor_id: ActorId

Actor that created this message.

§to_actor_id: Option<ActorId>

Intended recipient actor, if directed.

§vision_id: Option<VisionId>

Associated vision, if any.

§project_id: Option<ProjectId>

Associated project, if any.

§task_id: Option<TaskId>

Associated task, if any.

§lamport_ts: u64

Lamport logical timestamp for causal ordering.

§created_at: OffsetDateTime

Wall-clock creation time.

§expires_at: Option<OffsetDateTime>

Optional expiration time for this message.

§body: T

The typed message body.

§signature: MessageSignature

Ed25519 signature over the canonical envelope content.

Implementations§

impl<T> Envelope<T>
where T: RoutedBody + Serialize,

pub fn verify_with_key( &self, verifying_key: &VerifyingKey, ) -> Result<(), ProtocolError>

Verifies the envelope’s signature against the given public key.

pub fn into_wire(self) -> Result<WireEnvelope, ProtocolError>

Converts this typed envelope into a wire-format envelope with untyped JSON body.

Trait Implementations§

impl<T: Clone> Clone for Envelope<T>

fn clone(&self) -> Envelope<T>

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<T: Debug> Debug for Envelope<T>

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

Formats the value using the given formatter. Read more

impl<'de, T> Deserialize<'de> for Envelope<T>
where T: Deserialize<'de>,

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

Deserialize this value from the given Serde deserializer. Read more

impl<T> Serialize for Envelope<T>
where T: Serialize,

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

impl<T> Freeze for Envelope<T>
where T: Freeze,

impl<T> RefUnwindSafe for Envelope<T>
where T: RefUnwindSafe,

impl<T> Send for Envelope<T>
where T: Send,

impl<T> Sync for Envelope<T>
where T: Sync,

impl<T> Unpin for Envelope<T>
where T: Unpin,

impl<T> UnsafeUnpin for Envelope<T>
where T: UnsafeUnpin,

impl<T> UnwindSafe for Envelope<T>
where T: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

fn vzip(self) -> V

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