Skip to main content

RelayConfig

Struct RelayConfig 

Source
pub struct RelayConfig {
    pub cad_periodicity: CadPeriodicity,
    pub default_channel: RelayChannel,
    pub second_channel: Option<RelayChannel>,
}
Expand description

Which channels a relay scans and how often, as RelayConfReq sets them, TS011-1.0.1 section 10.1.

Fields§

§cad_periodicity: CadPeriodicity

How often the relay scans each channel.

§default_channel: RelayChannel

The default channel, one of the region’s.

§second_channel: Option<RelayChannel>

A second channel, scanned half a period after the default one.

Implementations§

Source§

impl RelayConfig

Source

pub const fn new( cad_periodicity: CadPeriodicity, default_channel: RelayChannel, ) -> RelayConfig

Scans one channel.

§Arguments
  • cad_periodicity - how often.
  • default_channel - the channel.
§Returns

The configuration.

Source

pub fn region_default(plan: &ChannelPlan<'_>) -> Option<RelayConfig>

The configuration a relay runs before its network sets one: the region’s first default channel, scanned once a second.

§Arguments
  • plan - the region’s plan.
§Returns

The configuration, or None for a region with no relay channels.

Source

pub const fn with_second_channel(self, channel: RelayChannel) -> RelayConfig

Adds a second channel.

§Arguments
  • channel - the channel.
§Returns

The configuration, for chaining.

Source

pub const fn channel(&self, channel: WorChannel) -> Option<RelayChannel>

Returns one of the channels.

§Arguments
  • channel - which.
§Returns

The channel, or None for a second channel the configuration does not have.

Trait Implementations§

Source§

impl Clone for RelayConfig

Source§

fn clone(&self) -> RelayConfig

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 Copy for RelayConfig

Source§

impl Debug for RelayConfig

Source§

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

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

impl Eq for RelayConfig

Source§

impl Hash for RelayConfig

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for RelayConfig

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for RelayConfig

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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.

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.