Skip to main content

Welcome

Struct Welcome 

Source
pub struct Welcome {
    pub proto: u32,
    pub link: String,
    pub card: RuntimeCard,
    pub nonce: String,
    pub ts: u64,
    pub marks: Marks,
    pub heartbeat_seconds: u64,
    pub expiry_seconds: u64,
}
Expand description

An answerer’s welcome: the mirror of the hello, plus the two things that make the link usable. The link id is what the dialer syncs under afterwards, and the marks let the very first sync carry exactly the events the answerer lacks instead of a round spent discovering that. The echoed nonce is what binds this welcome to that hello: without it, a welcome kept from an earlier exchange would answer a hello it never saw.

use std::collections::BTreeMap;
use majordomus_cli::mesh::identity::NodeIdentity;
use majordomus_cli::mesh::link::{fresh_token, sign, verify_signed, Domain, RuntimeCard,
    Welcome, LINK_PROTOCOL_MAX};

let node = NodeIdentity::ephemeral().unwrap();
let nonce = fresh_token();
let welcome = Welcome {
    proto: LINK_PROTOCOL_MAX,
    link: fresh_token(),
    card: RuntimeCard {
        pk: node.public.public_key.clone(),
        runtime: "00000000000000aa".into(),
        instance: node.public.instance_id.as_str().into(),
        repo: "r".repeat(32),
        name: String::new(),
        version: String::new(),
        features: vec![],
        endpoints: vec![],
    },
    nonce: nonce.clone(),
    ts: 1_700_000_000,
    marks: BTreeMap::new(),
    heartbeat_seconds: 5,
    expiry_seconds: 30,
};
assert_eq!(welcome.nonce, nonce, "this welcome answers that hello and no other");
assert!(welcome.marks.is_empty(), "a runtime that has written nothing has nothing to mark");

let signed = sign(&node, Domain::Welcome, serde_json::to_value(&welcome).unwrap());
assert!(verify_signed(&node.public.public_key, Domain::Welcome, &signed));

Fields§

§proto: u32

The negotiated protocol version.

§link: String

The link id the dialer syncs under.

§card: RuntimeCard

The answerer.

§nonce: String

The hello’s nonce, echoed: this welcome answers that hello and no other.

§ts: u64

The answerer’s clock.

§marks: Marks

The answerer’s marks, so the first sync carries exactly what it lacks.

§heartbeat_seconds: u64

The answerer’s heartbeat, informational.

§expiry_seconds: u64

The answerer’s expiry, informational.

Trait Implementations§

Source§

impl Clone for Welcome

Source§

fn clone(&self) -> Welcome

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 Debug for Welcome

Source§

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

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

impl<'de> Deserialize<'de> for Welcome

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for Welcome

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for Welcome

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Welcome

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 Welcome

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = Infallible

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

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

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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more