Struct Lsn 

pub struct Lsn(/* private fields */);

Available on crate features source-mssql-cdc and source-rest only.

A SQL Server change data capture Log Sequence Number.

Stored as a big-endian byte array; Ord is the derived lexicographic comparison, which for big-endian bytes equals numeric order.

Implementations

impl Lsn

pub const ZERO: Lsn

The all-zero LSN (0x0000...0000), the minimum possible value.

pub fn from_array(bytes: [u8; 10]) -> Lsn

Wrap a raw 10-byte big-endian array.

pub fn from_bytes(bytes: &[u8]) -> Result<Lsn, FaucetError>

Build an LSN from a byte slice. The slice must be exactly LSN_BYTES long; any other length is a typed error (SQL Server always returns binary(10), so a different width means a decode bug, not a data value).

pub fn from_hex(s: &str) -> Result<Lsn, FaucetError>

Parse an LSN from its hex string form (20 hex digits, case-insensitive, an optional 0x/0X prefix tolerated). Rejects any other length or a non-hex digit with a typed error.

pub fn to_hex(&self) -> String

Render as a 20-character lowercase hex string (no 0x prefix), matching CONVERT(VARCHAR(20), lsn, 2).

pub fn increment(&self) -> Option<Lsn>

The smallest LSN strictly greater than self — the client-side analogue of sys.fn_cdc_increment_lsn. Used to derive the half-open lower bound for the next poll from a durable bookmark, so a resumed run never re-reads the last already-committed change (the fn_cdc_get_all_changes range is inclusive of from_lsn).

Returns None only when self is the all-0xFF maximum (unreachable in practice — the log would have to wrap the entire 80-bit LSN space).

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 Display for Lsn

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

Formats the value using the given formatter.

impl Eq for Lsn

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

Equality operator ==.

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

Inequality operator !=.

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