Struct Lsn 

pub struct Lsn(pub u64);

PostgreSQL Log Sequence Number.

Represents a position in the write-ahead log (WAL). LSNs are used to track replication progress and identify specific points in the WAL stream.

Format

PostgreSQL displays LSNs as XXXXXXXX/YYYYYYYY where:

• XXXXXXXX is the high 32 bits (segment file number)
• YYYYYYYY is the low 32 bits (offset within segment)

Example

use pgwire_replication::lsn::Lsn;

let lsn = Lsn::parse("16/B374D848").unwrap();
assert_eq!(lsn.to_string(), "16/B374D848");

// Or use FromStr
let lsn: Lsn = "16/B374D848".parse().unwrap();

Tuple Fields

0: u64

Implementations

impl Lsn

pub const ZERO: Lsn

The zero LSN, representing “start from the beginning” or “no position”.

pub fn parse(s: &str) -> Result<Lsn, ParseLsnError>

Parse an LSN from PostgreSQL’s XXXXXXXX/YYYYYYYY format.

Errors

Returns ParseLsnError if the string is not valid LSN format.

pub fn to_pg_string(self) -> String

Format as PostgreSQL’s XXXXXXXX/YYYYYYYY string.

pub fn is_zero(self) -> bool

Returns true if this is the zero LSN.

pub fn as_u64(self) -> u64

Returns the raw 64-bit value.

pub fn from_u64(value: u64) -> Lsn

Create an LSN from a raw 64-bit value.

Trait Implementations

impl Clone for Lsn

fn clone(&self) -> Lsn

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Lsn

impl Debug for Lsn

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

Formats the value using the given formatter.

impl Default for Lsn

fn default() -> Lsn

Returns the “default value” for a type.

impl Display for Lsn

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

Formats the value using the given formatter.

impl Eq for Lsn

impl From<u64> for Lsn

fn from(value: u64) -> Lsn

Converts to this type from the input type.

impl FromStr for Lsn

type Err = ParseLsnError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Lsn, <Lsn as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Lsn

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Lsn

fn cmp(&self, other: &Lsn) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Lsn

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Lsn

fn partial_cmp(&self, other: &Lsn) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Lsn