Struct ElementRef 

#[non_exhaustive]
pub struct ElementRef {
    pub table: String,
    pub row: usize,
    pub source_uid: Option<String>,
    /* private fields */
}

A row in one table of the static payload.

source_uid is the row’s payload identity: when the referenced table carries uid values, a present source_uid resolves the target row and a present row must agree with it. In a table without uids (packages written before payload identity existed), source_uid is advisory and row addresses the update alone. On the wire, row may be omitted when source_uid is given.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

table: String

Payload table name, such as loads, generators, branches, or hvdc.

row: usize

Zero based row index in table. Meaningful only when the wire carried one; read ElementRef::wire_row before trusting it.

source_uid: Option<String>

The row’s payload identity (its uid field), when the producer knows it.

Implementations

impl ElementRef

pub fn new(table: impl Into<String>, row: usize) -> Self

pub fn by_source_uid(table: impl Into<String>, uid: impl Into<String>) -> Self

Address a row by payload identity alone; no row is serialized.

pub fn with_source_uid(self, uid: impl Into<String>) -> Self

pub fn wire_row(&self) -> Option<usize>

The wire row, when one was given.

Trait Implementations

impl Clone for ElementRef

fn clone(&self) -> ElementRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ElementRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ElementRef

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl PartialEq for ElementRef

fn eq(&self, other: &ElementRef) -> 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 Serialize for ElementRef

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Eq for ElementRef

impl StructuralPartialEq for ElementRef