Struct rpki_rtr::state::State

pub struct State { /* fields omitted */ }

The RTR session state.

This state consists of a session ID describing a continuous session with the same evolving data set a server is running and a serial number that describes a particular version of this set.

Both a session ID and an initial serial number are chosen when a new session is started. Whenever data is being updated, the serial number is increased by one.

This type contains both these values. You can create the state values for a new session with new and increase the serial number with inc.

Implementations

impl State

pub fn new() -> Self

Creates a state value for a new session.

This will pick a session ID based on the lower 16 bit of the current Unix time and an initial serial of 0. If you want to choose a different starting serial, you can use new_with_serial instead.

pub fn new_with_serial(serial: Serial) -> Self

Creates a state value with a given initial serial number.

The function will use a session ID based on the lower 16 bit of the current time and an initial serial of serial.

pub fn from_parts(session: u16, serial: Serial) -> Self

Creates a new state value from its components.

pub fn inc(&mut self)

Increases the serial number by one.

Serial number may wrap but that’s totally fine. See Serial for more details.

pub fn session(self) -> u16

Returns the session ID.

pub fn serial(self) -> Serial

Returns the serial number.

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for State

impl Debug for State

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

Formats the value using the given formatter.

impl Default for State

fn default() -> Self

Returns the "default value" for a type.