Struct Segment

pub struct Segment(/* private fields */);

A nonempty string slice that does not start or end with whitespace and does not contain any instances of Scope::SEPARATOR.

For the owned variant, see SegmentBuf.

Implementations

impl Segment

pub const fn parse(value: &str) -> Result<&Self, ParseSegmentError>

Parse a Segment from a string.

Examples

use kvx_types::Segment;

Segment::parse("segment")?;

Errors

If the string is empty, starts or ends with whitespace, or contains a Scope::SEPARATOR a ParseSegmentError variant will be returned.

pub fn as_str(&self) -> &str

Return the encapsulated string.

Examples

use kvx_types::Segment;

let segment_str = "segment";
let segment = Segment::parse(segment_str)?;
assert_eq!(segment.as_str(), segment_str);

pub const unsafe fn from_str_unchecked(s: &str) -> &Self

Creates a Segment from a string without performing any checks.

Safety

This function should only be called from the kvx_macros crate - do not use directly.

Trait Implementations

impl AsRef<Segment> for SegmentBuf

fn as_ref(&self) -> &Segment

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<Segment> for SegmentBuf

fn borrow(&self) -> &Segment

Immutably borrows from an owned value.

impl Debug for Segment

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

Formats the value using the given formatter.

impl Display for Segment

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

Formats the value using the given formatter.

impl From<&Segment> for SegmentBuf

fn from(value: &Segment) -> Self

Converts to this type from the input type.

impl Hash for Segment

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

Feeds this value into the given Hasher.

impl Ord for Segment

fn cmp(&self, other: &Segment) -> Ordering

This method returns an Ordering between self and other.

impl PartialEq for Segment

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

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

type Owned = SegmentBuf

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl ToSql for &Segment

fn to_sql( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

where Self: Sized,

Converts the value of self into the binary format of the specified Postgres Type, appending it to out.

fn accepts(ty: &Type) -> bool

where Self: Sized,

Determines if a value of this type can be converted to the specified Postgres Type.

fn to_sql_checked( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

An adaptor method used internally by Rust-Postgres.

fn encode_format(&self, _ty: &Type) -> Format

Specify the encode format

impl Eq for Segment

impl StructuralPartialEq for Segment