Struct ItemGroup 

pub struct ItemGroup { /* private fields */ }

Which items a subscription covers.

The protocol sends a single LS_group string and lets the server’s Metadata Adapter decide what it names [docs/spec/03-requests.md §6.1]. In practice adapters use one of two conventions, and this type supports both:

• a group name the adapter knows, resolved server-side into a list;
• a literal list of item names separated by spaces, which is what the stock adapters and the public demo server accept.

Examples

use lightstreamer_rs::ItemGroup;

let listed = ItemGroup::from_items(["item1", "item2", "item3"])?;
assert_eq!(listed.as_str(), "item1 item2 item3");

let named = ItemGroup::try_new("portfolio1")?;
assert_eq!(named.as_str(), "portfolio1");

Implementations

impl ItemGroup

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

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

Errors

• ConfigError::EmptyItemGroup if the name is empty or only whitespace.
• ConfigError::ItemGroupControlCharacter if it contains an ASCII control character. A guard of this crate: the specification gives no grammar for the name, but a control character in one is always a mistake.

pub fn from_items<I, S>(items: I) -> Result<Self, ConfigError>

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

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

Errors

• ConfigError::EmptyItemGroup if the iterator is empty.
• ConfigError::ItemNameHasWhitespace if any name contains whitespace, which would make it two items once joined.
• ConfigError::ItemGroupControlCharacter if any name contains an ASCII control character.

Examples

use lightstreamer_rs::{ConfigError, ItemGroup};

assert!(matches!(
    ItemGroup::from_items(["two words"]),
    Err(ConfigError::ItemNameHasWhitespace { .. })
));

pub fn as_str(&self) -> &str

The group as it goes on the wire, in LS_group.

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

The item names, when the caller spelled them out.

Empty for a group name the server resolves: TLCP never transmits item names, so this crate cannot know them and reports each item by its 1-based position instead [docs/spec/04-notifications.md §3.1].

Examples

use lightstreamer_rs::ItemGroup;

assert_eq!(ItemGroup::from_items(["a", "b"])?.names(), vec!["a", "b"]);
assert!(ItemGroup::try_new("portfolio1")?.names().is_empty());

Trait Implementations

impl Clone for ItemGroup

fn clone(&self) -> ItemGroup

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ItemGroup

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

Formats the value using the given formatter.

impl Eq for ItemGroup

impl Hash for ItemGroup

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 ItemGroup

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ItemGroup

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