Struct TrySegmentError

pub struct TrySegmentError { /* private fields */ }

An error that occurs when trying to create a segment with an invalid range.

This error indicates that the requested range extends beyond the buffer’s boundaries or is otherwise invalid (e.g., start > end). The original buffer remains unchanged.

Examples

let data = b"Hello";
let buf = &data[..];

// Range extends beyond buffer
match buf.try_segment(2..10) {
    Err(e) => {
        assert_eq!(e.start(), 2);
        assert_eq!(e.end(), 10);
        assert_eq!(e.available(), 5);
    }
    _ => panic!("Expected error"),
}

// Invalid range (start > end)
assert!(buf.try_segment(4..2).is_err());

Implementations

impl TrySegmentError

pub const fn new(start: usize, end: usize, available: usize) -> Self

Creates a new TrySegmentError.

Panics

In debug builds, panics if the range is valid (would not be an error) or the available bytes are less than the requested range.

pub const fn start(&self) -> usize

Returns the start index of the requested range.

pub const fn end(&self) -> usize

Returns the end index of the requested range (exclusive).

pub const fn available(&self) -> usize

Returns the total number of bytes available in the buffer.

pub const fn requested(&self) -> usize

Returns the length of the requested range.

Returns 0 if start > end (invalid range).

pub const fn is_inverted(&self) -> bool

Returns whether the range itself is invalid (start > end).

pub const fn overflow(&self) -> usize

Returns how many bytes the range extends beyond the buffer.

Returns 0 if the range doesn’t extend beyond the buffer (e.g., when the error is due to start > end).

Trait Implementations

impl Clone for TrySegmentError

fn clone(&self) -> TrySegmentError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TrySegmentError

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

Formats the value using the given formatter.

impl Display for TrySegmentError

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

Formats the value using the given formatter.

impl Error for TrySegmentError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<TrySegmentError> for Error

fn from(e: TrySegmentError) -> Self

Converts to this type from the input type.

impl PartialEq for TrySegmentError

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

impl Eq for TrySegmentError

impl StructuralPartialEq for TrySegmentError