Struct launchdarkly_server_sdk::Segment

pub struct Segment {
    pub key: String,
    pub included: Vec<String, Global>,
    pub excluded: Vec<String, Global>,
    pub unbounded: bool,
    pub version: u64,
    /* private fields */
}

Segment describes a group of users based on user keys and/or matching rules.

Fields

key: String

The unique key of the user segment.

included: Vec<String, Global>

A list of user keys that are always matched by this segment.

excluded: Vec<String, Global>

A list of user keys that are never matched by this segment, unless the key is also in included.

unbounded: bool

Unbounded is true if this is a segment whose included list is stored separately and is not limited in size. Currently, the server-side Rust SDK cannot access the user list for this kind of segment; it only works when flags are being evaluated within the LaunchDarkly service.

The name is historical: “unbounded segments” was an earlier name for the product feature that is currently known as “big segments”. If unbounded is true, this is a big segment.

version: u64

An integer that is incremented by LaunchDarkly every time the configuration of the segment is changed.

Implementations

impl Segment

pub fn contains(&self, user: &User) -> bool

Determines if the provided User is a part of this segment.

Inclusion can be determined by specifically listing the user key in the segment, or by matching any of the rules configured for this segment.

pub fn unbounded_segment_id(&self) -> String

Retrieve the id representing this big segment.

This id will either be the segment key if the segment isn’t a big segment, or it will be a combination of the segment key and the segment generation id.

Trait Implementations

impl Clone for Segment

fn clone(&self) -> Segment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Segment

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

Formats the value using the given formatter.

impl Default for Segment

fn default() -> Segment

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Segment

fn deserialize<__D>(
    __deserializer: __D
) -> Result<Segment, <__D as Deserializer<'de>>::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Segment

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Versioned for Segment

fn version(&self) -> u64

Retrieve the version for this item instance.

fn is_greater_than_or_equal(&self, version: u64) -> bool

Determine if this item’s version is greater than or equal to the provided version parameter.