Struct offset_string::OffsetString

pub struct OffsetString(_);

A compact representation of a set of unsigned integer ranges.

The primary use case is succinctly encoding a large set of Unicode code points in JSON.

If the set of ranges is

[1..=3, 8..=9, 13..=13, 18..=20]

the OffsetString will be

"1+2,5+1,4,4+3"

In each entry, the first number is the offset from the end of the previous range. If the current range has length > 1, then there’s a ‘+x’ that shows how much to add to get the upper bound of the range. Note that the range [13, 14) has length 1, so it doesn’t get a plus suffix.

Implementations

impl OffsetString

pub fn new<T: AsRef<str>>(source: T) -> Result<OffsetString, Error>

Tries to construct a new OffsetString from a string.

This method performs basic validation on whether the string is syntactically valid and does not contain any redundantly short ranges. Returns an Error if validation fails.

pub fn iter_ranges<'a>( &'a self ) -> impl Iterator<Item = RangeInclusive<u32>> + 'a

Iterate over the numeric ranges in the collection.

pub fn iter<'a>(&'a self) -> impl Iterator<Item = u32> + 'a

Iterate over the individual unsigned integers in the collection.

Trait Implementations

impl Debug for OffsetString

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OffsetString

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

Deserialize this value from the given Serde deserializer.

impl From<&CharCollection> for OffsetString

fn from(value: &CharCollection) -> OffsetString

Converts to this type from the input type.

impl From<&CharSet> for OffsetString

fn from(char_set: &CharSet) -> OffsetString

Converts to this type from the input type.

impl From<CharCollection> for OffsetString

fn from(value: CharCollection) -> OffsetString

Converts to this type from the input type.

impl From<CharSet> for OffsetString

fn from(value: CharSet) -> OffsetString

Converts to this type from the input type.

impl From<OffsetString> for String

fn from(value: OffsetString) -> String

Converts to this type from the input type.

impl PartialEq<OffsetString> for OffsetString

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for OffsetString

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

Serialize this value into the given Serde serializer.

impl TryFrom<&OffsetString> for CharCollection

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &OffsetString) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&OffsetString> for CharSet

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &OffsetString) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for OffsetString

type Error = Error

The type returned in the event of a conversion error.

fn try_from(source: &str) -> Result<OffsetString, Error>

Performs the conversion.

impl TryFrom<OffsetString> for CharCollection

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: OffsetString) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<OffsetString> for CharSet

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: OffsetString) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for OffsetString

type Error = Error

The type returned in the event of a conversion error.

fn try_from(source: String) -> Result<OffsetString, Error>

Performs the conversion.

impl Eq for OffsetString

impl StructuralEq for OffsetString

impl StructuralPartialEq for OffsetString