Struct FieldSchema 

pub struct FieldSchema { /* private fields */ }

Which fields a subscription asks for.

The mirror of ItemGroup on the field side: LS_schema is one string the Metadata Adapter resolves, either a schema name it knows or a space-separated list of field names [docs/spec/03-requests.md §6.1].

The order matters: it is the order in which values arrive in every update, and the order the field indices of an update refer to.

Examples

use lightstreamer_rs::FieldSchema;

let schema = FieldSchema::from_fields(["last_price", "time", "pct_change"])?;
assert_eq!(schema.as_str(), "last_price time pct_change");

Implementations

impl FieldSchema

pub fn try_new(schema: impl Into<String>) -> Result<Self, ConfigError>

Wraps a schema name the server’s Metadata Adapter will resolve.

Errors

• ConfigError::EmptyFieldSchema if the name is empty or only whitespace.
• ConfigError::FieldSchemaControlCharacter if it contains an ASCII control character.

pub fn from_fields<I, S>(fields: I) -> Result<Self, ConfigError>

where I: IntoIterator<Item = S>, S: Into<String>,

Builds the space-separated list convention from individual field names.

Errors

• ConfigError::EmptyFieldSchema if the iterator is empty.
• ConfigError::FieldNameHasWhitespace if any name contains whitespace.
• ConfigError::FieldSchemaControlCharacter if any name contains an ASCII control character.

pub fn as_str(&self) -> &str

The schema as it goes on the wire, in LS_schema.

pub fn names(&self) -> Vec<&str>

The field names, when the caller spelled them out.

Empty for a schema name the server resolves: TLCP announces only how many fields a subscription has, never what they are called [docs/spec/04-notifications.md §3.1], so in that case every field is reported by its 1-based position instead.

Trait Implementations

impl Clone for FieldSchema

fn clone(&self) -> FieldSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldSchema

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

Formats the value using the given formatter.

impl Eq for FieldSchema

impl Hash for FieldSchema

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

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 FieldSchema

fn cmp(&self, other: &FieldSchema) -> 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 FieldSchema

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for FieldSchema

fn partial_cmp(&self, other: &FieldSchema) -> 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 FieldSchema