Skip to main content

PvString

Struct PvString 

Source
pub struct PvString(/* private fields */);
Expand description

A wire string: a sequence of bytes that is not guaranteed to be valid UTF-8. Backs EpicsValue::String/StringArray and (in epics-pva-rs) ScalarValue::String/TypedScalarArray::String. See the module docs for why this is a byte newtype rather than String.

Implementations§

Source§

impl PvString

Source

pub fn new() -> PvString

An empty wire string.

Source

pub fn from_bytes(bytes: impl Into<Vec<u8>>) -> PvString

Wrap raw bytes verbatim (the decode path: bytes straight off the wire).

Source

pub fn as_bytes(&self) -> &[u8]

The logical bytes, layout-agnostic (an encoder applies CA’s 40-byte NUL padding or PVA’s size prefix; this is the unframed content).

Source

pub fn into_bytes(self) -> Vec<u8>

Consume into the owned byte buffer.

Source

pub fn as_str_lossy(&self) -> Cow<'_, str>

Lossy UTF-8 view for diagnostics / JSON / text comparisons where a faithful byte rendering is not required. Non-UTF-8 bytes become U+FFFD. For pvxs-faithful CLI output, escape Self::as_bytes byte-wise instead.

Source

pub fn len(&self) -> usize

Number of logical bytes.

Source

pub fn is_empty(&self) -> bool

True when the string carries no bytes.

Trait Implementations§

Source§

impl AsRef<[u8]> for PvString

Source§

fn as_ref(&self) -> &[u8]

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

impl Clone for PvString

Source§

fn clone(&self) -> PvString

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PvString

Source§

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

Quoted, escaped rendering of the lossy text view — keeps {:?} output readable (mirrors String’s Debug for the common ASCII/UTF-8 case).

Source§

impl Default for PvString

Source§

fn default() -> PvString

Returns the “default value” for a type. Read more
Source§

impl Display for PvString

Source§

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

Lossy text rendering for diagnostics and {}-formatting. This is the “diagnostic” policy (pvxs uses a byte-wise escaper for its CLI output; that lives in the epics-pva-rs format layer and consumes Self::as_bytes directly).

Source§

impl Eq for PvString

Source§

impl From<&String> for PvString

Source§

fn from(s: &String) -> PvString

Converts to this type from the input type.
Source§

impl From<&[u8]> for PvString

Source§

fn from(b: &[u8]) -> PvString

Converts to this type from the input type.
Source§

impl From<&str> for PvString

Source§

fn from(s: &str) -> PvString

Converts to this type from the input type.
Source§

impl From<Cow<'_, str>> for PvString

Source§

fn from(s: Cow<'_, str>) -> PvString

Converts to this type from the input type.
Source§

impl From<PvString> for Vec<u8>

Source§

fn from(s: PvString) -> Vec<u8>

Converts to this type from the input type.
Source§

impl From<String> for PvString

Source§

fn from(s: String) -> PvString

Converts to this type from the input type.
Source§

impl From<Vec<u8>> for PvString

Source§

fn from(b: Vec<u8>) -> PvString

Converts to this type from the input type.
Source§

impl Hash for PvString

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for PvString

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for PvString

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialEq<&str> for PvString

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialEq<PvString> for str

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialEq<PvString> for &str

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialEq<String> for PvString

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialEq<str> for PvString

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for PvString

Source§

fn partial_cmp(&self, other: &PvString) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl StructuralPartialEq for PvString

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more