Skip to main content

CoreEffect

Enum CoreEffect

pub enum CoreEffect {
Show 28 variants    SendFrame {
        session: SessionId,
        envelope: Envelope,
    },
    HandshakeEstablished {
        session: SessionId,
        version: u16,
    },
    DeliverClient {
        session: SessionId,
        operation: ClientOperationId,
        delivery: ClientDelivery,
    },
    RegisterClient {
        session: SessionId,
        operation: ClientOperationId,
    },
    ScheduleClientDeadline {
        session: SessionId,
        operation: ClientOperationId,
        deadline: Instant,
    },
    Deliver {
        session: SessionId,
        envelope: Envelope,
    },
    ReleaseBody {
        session: SessionId,
        body: BodyId,
    },
    StreamClosed {
        session: SessionId,
        operation: ClientOperationId,
    },
    CloseTransport {
        session: SessionId,
        code: ErrorCode,
        message: String,
    },
    ScheduleSessionDeadline {
        session: SessionId,
        deadline: Instant,
    },
    RequestPeerAdmission {
        effect: EffectId,
        session: SessionId,
        remote: NodeIdentity,
    },
    AbortDispatch {
        session: SessionId,
        effect: EffectId,
    },
    CheckDispatchCapacity {
        effect: EffectId,
        stream: StreamKey,
        frame: ApplicationFrame,
    },
    InvokeApplication {
        effect: EffectId,
        invocation: ApplicationInvocation,
    },
    OpenRelay {
        effect: EffectId,
        source: StreamKey,
        peer: String,
        frame: ApplicationFrame,
    },
    AwaitTargetReadiness {
        effect: EffectId,
        stream: StreamKey,
        target: String,
    },
    ForwardRelay {
        effect: EffectId,
        source: StreamKey,
        target: StreamKey,
        frame: ApplicationFrame,
        terminal: bool,
    },
    Send {
        effect: EffectId,
        session: SessionId,
        frame: ApplicationFrame,
    },
    SendProtocol {
        effect: EffectId,
        session: SessionId,
        envelope: Envelope,
    },
    SessionEstablished {
        session: SessionId,
        peer: NodeIdentity,
    },
    SessionRetired {
        session: SessionId,
        reason: RetirementReason,
    },
    RouteSnapshotApplied {
        session: SessionId,
        peer: String,
        snapshot: RouteSnapshot,
        changed: bool,
    },
    RouteDeltaApplied {
        session: SessionId,
        peer: String,
        delta: RouteDelta,
        changed: bool,
    },
    RouteSessionWithdrawn {
        session: SessionId,
        changed: bool,
    },
    RouteExportAcked {
        session: SessionId,
    },
    QueryDiscoveryNeighbor {
        stream: StreamKey,
        peer: String,
        plan: DiscoverPlan,
    },
    QueryDiscoveryTarget {
        stream: StreamKey,
        peer: String,
        target_path: String,
        plan: DiscoverPlan,
    },
    ContinueDiscovery {
        stream: StreamKey,
    },
}

Variants§

SendFrame

Fields

§session: SessionId

§envelope: Envelope

HandshakeEstablished

Fields

§session: SessionId

§version: u16

DeliverClient

Fields

§session: SessionId

§operation: ClientOperationId

§delivery: ClientDelivery

RegisterClient

Fields

§session: SessionId

§operation: ClientOperationId

ScheduleClientDeadline

Fields

§session: SessionId

§operation: ClientOperationId

§deadline: Instant

Deliver

Fields

§session: SessionId

§envelope: Envelope

ReleaseBody

Fields

§session: SessionId

§body: BodyId

StreamClosed

Fields

§session: SessionId

§operation: ClientOperationId

CloseTransport

Fields

§session: SessionId

§code: ErrorCode

§message: String

ScheduleSessionDeadline

Fields

§session: SessionId

§deadline: Instant

RequestPeerAdmission

Fields

§effect: EffectId

§session: SessionId

§remote: NodeIdentity

AbortDispatch

Fields

§session: SessionId

§effect: EffectId

CheckDispatchCapacity

Fields

§effect: EffectId

§stream: StreamKey

§frame: ApplicationFrame

InvokeApplication

Fields

§effect: EffectId

§invocation: ApplicationInvocation

OpenRelay

Fields

§effect: EffectId

§source: StreamKey

§peer: String

§frame: ApplicationFrame

AwaitTargetReadiness

Fields

§effect: EffectId

§stream: StreamKey

§target: String

ForwardRelay

Fields

§effect: EffectId

§source: StreamKey

§target: StreamKey

§frame: ApplicationFrame

§terminal: bool

Send

Fields

§effect: EffectId

§session: SessionId

§frame: ApplicationFrame

SendProtocol

Fields

§effect: EffectId

§session: SessionId

§envelope: Envelope

SessionEstablished

Fields

§session: SessionId

§peer: NodeIdentity

SessionRetired

Fields

§session: SessionId

§reason: RetirementReason

RouteSnapshotApplied

Fields

§session: SessionId

§peer: String

§snapshot: RouteSnapshot

§changed: bool

RouteDeltaApplied

Fields

§session: SessionId

§peer: String

§delta: RouteDelta

§changed: bool

RouteSessionWithdrawn

Fields

§session: SessionId

§changed: bool

RouteExportAcked

Fields

§session: SessionId

QueryDiscoveryNeighbor

Fields

§stream: StreamKey

§peer: String

§plan: DiscoverPlan

QueryDiscoveryTarget

Fields

§stream: StreamKey

§peer: String

§target_path: String

§plan: DiscoverPlan

ContinueDiscovery

Fields

§stream: StreamKey

Implementations§

impl CoreEffect

pub fn session(&self) -> &SessionId

Trait Implementations§

impl Clone for CoreEffect

fn clone(&self) -> CoreEffect

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

impl Debug for CoreEffect

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

Formats the value using the given formatter. Read more

impl PartialEq for CoreEffect

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl StructuralPartialEq for CoreEffect

Auto Trait Implementations§

impl !Freeze for CoreEffect

impl RefUnwindSafe for CoreEffect

impl Send for CoreEffect

impl Sync for CoreEffect

impl Unpin for CoreEffect

impl UnsafeUnpin for CoreEffect

impl UnwindSafe for CoreEffect

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> DynClone for T
where T: Clone,

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

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