Enum safe_network::routing::Event[−][src]

pub enum Event {
    MessageReceived {
        msg_id: MessageId,
        src: SrcLocation,
        dst: DstLocation,
        msg: Box<MessageReceived>,
    },
    MemberJoined {
        name: XorName,
        previous_name: Option<XorName>,
        age: u8,
    },
    MemberLeft {
        name: XorName,
        age: u8,
    },
    SectionSplit {
        elders: Elders,
        self_status_change: NodeElderChange,
    },
    EldersChanged {
        elders: Elders,
        self_status_change: NodeElderChange,
    },
    RelocationStarted {
        previous_name: XorName,
    },
    Relocated {
        previous_name: XorName,
        new_keypair: Arc<Keypair>,
    },
    ServiceMsgReceived {
        msg_id: MessageId,
        msg: Box<ServiceMsg>,
        auth: AuthorityProof<ServiceAuth>,
        user: EndUser,
        dst_location: DstLocation,
    },
    AdultsChanged {
        remaining: BTreeSet<XorName>,
        added: BTreeSet<XorName>,
        removed: BTreeSet<XorName>,
    },
}

Expand description

An Event raised by a Node or Client via its event sender.

These are sent by sn_routing to the library’s user. It allows the user to handle requests and responses, and to react to changes in the network.

Request and Response events from section locations are only raised once the majority has been reached, i.e. enough members of the section have sent the same message.

Variants

`MessageReceived`

Fields

msg_id: MessageId

The message ID

src: SrcLocation

Source location

dst: DstLocation

Destination location

msg: Box<MessageReceived>

The message.

Received a message from another Node.

`MemberJoined`

Fields

name: XorName

Name of the node

previous_name: Option<XorName>

Previous name before relocation or None if it is a new node.

age: u8

Age of the node

A new peer joined our section.

`MemberLeft`

Fields

name: XorName

Name of the node

age: u8

Age of the node

A node left our section.

`SectionSplit`

Fields

elders: Elders

The Elders of our section.

self_status_change: NodeElderChange

Promoted, demoted or no change?

Our section has split.

`EldersChanged`

Fields

elders: Elders

The Elders of our section.

self_status_change: NodeElderChange

Promoted, demoted or no change?

The set of elders in our section has changed.

`RelocationStarted`

Fields

previous_name: XorName

Previous name before relocation

This node has started relocating to other section. Will be followed by Relocated when the node finishes joining the destination section.

`Relocated`

Fields

previous_name: XorName

Old name before the relocation.

new_keypair: Arc<Keypair>

New keypair to be used after relocation.

This node has completed relocation to other section.

`ServiceMsgReceived`

Fields

msg_id: MessageId

The message ID

msg: Box<ServiceMsg>

The content of the message.

auth: AuthorityProof<ServiceAuth>

Data authority

user: EndUser

The end user that sent the message. Its xorname is derived from the client public key, and the socket_id maps against the actual socketaddr

dst_location: DstLocation

DstLocation for the message

Received a message from a peer.

`AdultsChanged`

Fields

remaining: BTreeSet<XorName>

Remaining Adults in our section.

added: BTreeSet<XorName>

New Adults in our section.

removed: BTreeSet<XorName>

Removed Adults in our section.

Notify the current list of adult nodes, in case of churning.

Trait Implementations

[src]

impl Debug for Event

[src]

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl Send for Event

impl Sync for Event

Blanket Implementations

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T> Instrument for T

[src]

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

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

[src]

fn in_current_span(self) -> Instrumented<Self>

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

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

impl<D> OwoColorize for D

fn fg<C>(&'a self) -> FgColorDisplay<'a, C, Self> where
C: Color,

Set the foreground color generically Read more

fn bg<C>(&'a self) -> BgColorDisplay<'a, C, Self> where
C: Color,

Set the background color generically. Read more

fn black(&'a self) -> FgColorDisplay<'a, Black, Self>

Change the foreground color to black

fn on_black(&'a self) -> BgColorDisplay<'a, Black, Self>

Change the foreground color to black

fn red(&'a self) -> FgColorDisplay<'a, Red, Self>

Change the foreground color to red

fn on_red(&'a self) -> BgColorDisplay<'a, Red, Self>

Change the foreground color to red

fn green(&'a self) -> FgColorDisplay<'a, Green, Self>

Change the foreground color to green

fn on_green(&'a self) -> BgColorDisplay<'a, Green, Self>

Change the foreground color to green

fn yellow(&'a self) -> FgColorDisplay<'a, Yellow, Self>

Change the foreground color to yellow

fn on_yellow(&'a self) -> BgColorDisplay<'a, Yellow, Self>

Change the foreground color to yellow

fn blue(&'a self) -> FgColorDisplay<'a, Blue, Self>

Change the foreground color to blue

fn on_blue(&'a self) -> BgColorDisplay<'a, Blue, Self>

Change the foreground color to blue

fn magenta(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to magenta

fn on_magenta(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the foreground color to magenta

fn purple(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to purple

fn on_purple(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the foreground color to purple

fn cyan(&'a self) -> FgColorDisplay<'a, Cyan, Self>

Change the foreground color to cyan

fn on_cyan(&'a self) -> BgColorDisplay<'a, Cyan, Self>

Change the foreground color to cyan

fn white(&'a self) -> FgColorDisplay<'a, White, Self>

Change the foreground color to white

fn on_white(&'a self) -> BgColorDisplay<'a, White, Self>

Change the foreground color to white

fn bright_black(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>

Change the foreground color to bright black

fn on_bright_black(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>

Change the foreground color to bright black

fn bright_red(&'a self) -> FgColorDisplay<'a, BrightRed, Self>

Change the foreground color to bright red

fn on_bright_red(&'a self) -> BgColorDisplay<'a, BrightRed, Self>

Change the foreground color to bright red

fn bright_green(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>

Change the foreground color to bright green

fn on_bright_green(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>

Change the foreground color to bright green

fn bright_yellow(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>

Change the foreground color to bright yellow

fn on_bright_yellow(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>

Change the foreground color to bright yellow

fn bright_blue(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>

Change the foreground color to bright blue

fn on_bright_blue(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>

Change the foreground color to bright blue

fn bright_magenta(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright magenta

fn on_bright_magenta(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright magenta

fn bright_purple(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright purple

fn on_bright_purple(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright purple

fn bright_cyan(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>

Change the foreground color to bright cyan

fn on_bright_cyan(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>

Change the foreground color to bright cyan

fn bright_white(&'a self) -> FgColorDisplay<'a, BrightWhite, Self>

Change the foreground color to bright white

fn on_bright_white(&'a self) -> BgColorDisplay<'a, BrightWhite, Self>

Change the foreground color to bright white

fn bold(&'a self) -> BoldDisplay<'a, Self>

Make the text bold

fn dimmed(&'a self) -> DimDisplay<'a, Self>

Make the text dim

fn italic(&'a self) -> ItalicDisplay<'a, Self>

Make the text italicized

fn underline(&'a self) -> UnderlineDisplay<'a, Self>

Make the text italicized

fn blink(&'a self) -> BlinkDisplay<'a, Self>

Make the text blink

fn blink_fast(&'a self) -> BlinkFastDisplay<'a, Self>

Make the text blink (but fast!)

fn reversed(&'a self) -> ReversedDisplay<'a, Self>

Swap the foreground and background colors

fn hidden(&'a self) -> HiddenDisplay<'a, Self>

Hide the text

fn strikethrough(&'a self) -> StrikeThroughDisplay<'a, Self>

Cross out the text

fn color<Color>(&'a self, color: Color) -> FgDynColorDisplay<'a, Color, Self> where
Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more

fn on_color<Color>(&'a self, color: Color) -> BgDynColorDisplay<'a, Color, Self> where
Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more

fn truecolor(&'a self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'a, Rgb, Self>

Sets the foreground color to an RGB value.

fn on_truecolor(
 &'a self,
 r: u8,
 g: u8,
 b: u8
) -> BgDynColorDisplay<'a, Rgb, Self>

Sets the background color to an RGB value.

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

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

[src]

impl<T> Same<T> for T

type Output = T

Should always be Self

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

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

pub fn vzip(self) -> V

[src]

impl<T> WithSubscriber for T

[src]

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

[src]

fn with_current_subscriber(self) -> WithDispatch<Self>

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

Enum safe_network::routing::Event[−][src]

Variants

MessageReceived

Fields

MemberJoined

Fields

MemberLeft

Fields

SectionSplit

Fields

EldersChanged

Fields

RelocationStarted

Fields

Relocated

Fields

ServiceMsgReceived

Fields

AdultsChanged

Fields

Trait Implementations

impl Debug for Event

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

Auto Trait Implementations

impl RefUnwindSafe for Event

impl Send for Event

impl Sync for Event

impl Unpin for Event

impl UnwindSafe for Event

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

pub fn into(self) -> U

impl<D> OwoColorize for D

fn fg<C>(&'a self) -> FgColorDisplay<'a, C, Self> where C: Color,

fn bg<C>(&'a self) -> BgColorDisplay<'a, C, Self> where C: Color,

fn black(&'a self) -> FgColorDisplay<'a, Black, Self>

fn on_black(&'a self) -> BgColorDisplay<'a, Black, Self>

fn red(&'a self) -> FgColorDisplay<'a, Red, Self>

fn on_red(&'a self) -> BgColorDisplay<'a, Red, Self>

fn green(&'a self) -> FgColorDisplay<'a, Green, Self>

fn on_green(&'a self) -> BgColorDisplay<'a, Green, Self>

fn yellow(&'a self) -> FgColorDisplay<'a, Yellow, Self>

fn on_yellow(&'a self) -> BgColorDisplay<'a, Yellow, Self>

fn blue(&'a self) -> FgColorDisplay<'a, Blue, Self>

fn on_blue(&'a self) -> BgColorDisplay<'a, Blue, Self>

fn magenta(&'a self) -> FgColorDisplay<'a, Magenta, Self>

fn on_magenta(&'a self) -> BgColorDisplay<'a, Magenta, Self>

fn purple(&'a self) -> FgColorDisplay<'a, Magenta, Self>

fn on_purple(&'a self) -> BgColorDisplay<'a, Magenta, Self>

fn cyan(&'a self) -> FgColorDisplay<'a, Cyan, Self>

fn on_cyan(&'a self) -> BgColorDisplay<'a, Cyan, Self>

fn white(&'a self) -> FgColorDisplay<'a, White, Self>

fn on_white(&'a self) -> BgColorDisplay<'a, White, Self>

fn bright_black(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>

fn on_bright_black(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>

fn bright_red(&'a self) -> FgColorDisplay<'a, BrightRed, Self>

fn on_bright_red(&'a self) -> BgColorDisplay<'a, BrightRed, Self>

fn bright_green(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>

fn on_bright_green(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>

fn bright_yellow(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>

fn on_bright_yellow(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>

fn bright_blue(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>

fn on_bright_blue(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>

fn bright_magenta(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

fn on_bright_magenta(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

fn bright_purple(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

fn on_bright_purple(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

fn bright_cyan(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>

fn on_bright_cyan(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>

`MessageReceived`

`MemberJoined`

`MemberLeft`

`SectionSplit`

`EldersChanged`

`RelocationStarted`

`Relocated`

`ServiceMsgReceived`

`AdultsChanged`

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

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

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

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

fn fg<C>(&'a self) -> FgColorDisplay<'a, C, Self> where
C: Color,

fn bg<C>(&'a self) -> BgColorDisplay<'a, C, Self> where
C: Color,

fn color<Color>(&'a self, color: Color) -> FgDynColorDisplay<'a, Color, Self> where
Color: DynColor,

fn on_color<Color>(&'a self, color: Color) -> BgDynColorDisplay<'a, Color, Self> where
Color: DynColor,

fn on_truecolor(
&'a self,
r: u8,
g: u8,
b: u8
) -> BgDynColorDisplay<'a, Rgb, Self>

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

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

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

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