Enum holochain::prelude::wire::Wire

source ·
pub enum Wire {
Show 14 variants Failure(Failure), Call(Call), CallResp(CallResp), DelegateBroadcast(DelegateBroadcast), Broadcast(Broadcast), Gossip(Gossip), PeerGet(PeerGet), PeerGetResp(PeerGetResp), PeerQuery(PeerQuery), PeerQueryResp(PeerQueryResp), PeerUnsolicited(PeerUnsolicited), FetchOp(FetchOp), PushOpData(PushOpData), MetricExchange(MetricExchange),
}
Expand description

KitsuneP2p Wire Protocol Top-Level Enum.

Variants§

§

Failure(Failure)

Failure

§

Call(Call)

“Call” to the remote.

§

CallResp(CallResp)

“Call” response from the remote.

§

DelegateBroadcast(DelegateBroadcast)

“DelegateBroadcast” to the remote. Remote should in turn connect to nodes in neighborhood, and call “Notify” per broadcast algorithm. uses low-level notify, not request

§

Broadcast(Broadcast)

Fire-and-forget broadcast message. uses low-level notify, not request

§

Gossip(Gossip)

Gossip op with opaque data section, to be forwarded to gossip module. uses low-level notify, not request

§

PeerGet(PeerGet)

Ask a remote node if they know about a specific agent

§

PeerGetResp(PeerGetResp)

Response to a peer get. If the agent isn’t known, None will be returned.

§

PeerQuery(PeerQuery)

Query a remote node for peers holding or nearest to holding a u32 location.

§

PeerQueryResp(PeerQueryResp)

Response to a peer query. May be empty if no matching agents are known.

§

PeerUnsolicited(PeerUnsolicited)

Nodes can just send peer info without prompting. Notably they may want to send their own peer info to prevent being inadvertantly blocked.

§

FetchOp(FetchOp)

Request the peer send op data. This is sent as a fire-and-forget Notify message. The “response” is “PushOpData” below.

§

PushOpData(PushOpData)

This is a fire-and-forget “response” to the fire-and-forget “FetchOp” request, also sent via Notify.

§

MetricExchange(MetricExchange)

MetricsExchangeMessage

Implementations§

source§

impl Wire

source

pub fn failure(reason: String) -> Wire

Variant constructor helper function.

source

pub fn call( space: Arc<KitsuneSpace>, to_agent: Arc<KitsuneAgent>, data: WireData ) -> Wire

Variant constructor helper function.

source

pub fn call_resp(data: WireData) -> Wire

Variant constructor helper function.

source

pub fn delegate_broadcast( space: Arc<KitsuneSpace>, basis: Arc<KitsuneBasis>, to_agent: Arc<KitsuneAgent>, mod_idx: u32, mod_cnt: u32, data: BroadcastData ) -> Wire

Variant constructor helper function.

source

pub fn broadcast( space: Arc<KitsuneSpace>, to_agent: Arc<KitsuneAgent>, data: BroadcastData ) -> Wire

Variant constructor helper function.

source

pub fn gossip( space: Arc<KitsuneSpace>, data: WireData, module: GossipModuleType ) -> Wire

Variant constructor helper function.

source

pub fn peer_get(space: Arc<KitsuneSpace>, agent: Arc<KitsuneAgent>) -> Wire

Variant constructor helper function.

source

pub fn peer_get_resp(agent_info_signed: Option<AgentInfoSigned>) -> Wire

Variant constructor helper function.

source

pub fn peer_query(space: Arc<KitsuneSpace>, basis_loc: DhtLocation) -> Wire

Variant constructor helper function.

source

pub fn peer_query_resp(peer_list: Vec<AgentInfoSigned>) -> Wire

Variant constructor helper function.

source

pub fn peer_unsolicited(peer_list: Vec<AgentInfoSigned>) -> Wire

Variant constructor helper function.

source

pub fn fetch_op(fetch_list: Vec<(Arc<KitsuneSpace>, Vec<FetchKey>)>) -> Wire

Variant constructor helper function.

source

pub fn push_op_data( op_data_list: Vec<(Arc<KitsuneSpace>, Vec<PushOpItem>)> ) -> Wire

Variant constructor helper function.

source

pub fn metric_exchange( space: Arc<KitsuneSpace>, msgs: Vec<MetricExchangeMsg> ) -> Wire

Variant constructor helper function.

source§

impl Wire

Trait Implementations§

source§

impl Clone for Wire

source§

fn clone(&self) -> Wire

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Codec for Wire

source§

fn variant_type(&self) -> &'static str

Variant identifier (for debugging or as a cheap discriminant).
source§

fn encode<W>(&self, w: &mut W) -> Result<(), Error>
where W: Write,

Encode this item to given writer. You may wish to first wrap your writer in a BufWriter.
source§

fn decode<R>(r: &mut R) -> Result<Wire, Error>
where R: Read,

Decode a reader into this item. You may wish to first wrap your reader in a BufReader.
source§

fn encode_vec(&self) -> Result<Vec<u8>, Error>

Encode this item to an owned vector of bytes. Uses encode() internally.
source§

fn decode_ref(r: &[u8]) -> Result<(u64, Self), Error>

Decode a range of bytes into this item. Will also return the byte count read. Uses decode() internally.
source§

impl Debug for Wire

source§

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

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

impl PartialEq for Wire

source§

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

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

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

impl Eq for Wire

source§

impl StructuralEq for Wire

source§

impl StructuralPartialEq for Wire

Auto Trait Implementations§

§

impl RefUnwindSafe for Wire

§

impl Send for Wire

§

impl Sync for Wire

§

impl Unpin for Wire

§

impl UnwindSafe for Wire

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
§

impl<T> Any for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

§

fn type_name(&self) -> &'static str

§

impl<T> AnySync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

§

impl<T> ArchivePointee for T

§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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<F, W, T, D> Deserialize<With<T, W>, D> for F
where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

§

fn deserialize( &self, deserializer: &mut D ) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
source§

impl<T> Instrument for T

source§

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T> Instrument for T

source§

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

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

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> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Pointee for T

§

type Metadata = ()

The type for metadata in pointers and references to Self.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
source§

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

§

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>,

§

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>,

§

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> Upcastable for T
where T: Any + Send + Sync + 'static,

§

fn upcast_any_ref(&self) -> &(dyn Any + 'static)

upcast ref
§

fn upcast_any_mut(&mut self) -> &mut (dyn Any + 'static)

upcast mut ref
§

fn upcast_any_box(self: Box<T>) -> Box<dyn Any>

upcast boxed dyn
§

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

§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> WithSubscriber for T

source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,