Struct DirectoryItemResponse 

pub struct DirectoryItemResponse { /* private fields */ }

Available on crate features clients or servers only.

Implementations

impl DirectoryItemResponse

pub fn new_next(info: SataFDInfo, path: String) -> Result<Self, PcfsApiError>

Create a Directory Item.

This assumes there was another item in the directory and we want to return it.

Errors

If the path is longer than 255 bytes.

pub const fn new_nothing_left() -> Self

Return that there’s nothing left in the directory.

pub const fn new_error_code(rc: u32) -> Self

Create a new directory item response given an error code.

pub const fn return_code(&self) -> u32

Get the underlying return code for this directory item.

pub fn is_successful(&self) -> bool

Return if this directory item was ‘successfully’ fetched.

This is really only useful when performing manual construction of the read directory packet. As when deserializing we will always return a proper error code if it’s not successful.

pub const fn file_info(&self) -> Option<&(SataFDInfo, String)>

Get the file that was returned as being next in the directory.

pub fn take_file_info(self) -> Option<(SataFDInfo, String)>

Consume the underlying packet, and just get the next file info if there is any.

Trait Implementations

impl Clone for DirectoryItemResponse

fn clone(&self) -> DirectoryItemResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DirectoryItemResponse

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

Formats the value using the given formatter.

impl From<&DirectoryItemResponse> for Bytes

fn from(value: &DirectoryItemResponse) -> Self

Converts to this type from the input type.

impl From<DirectoryItemResponse> for Bytes

fn from(value: DirectoryItemResponse) -> Self

Converts to this type from the input type.

impl PartialEq for DirectoryItemResponse

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

fn definition(&self) -> StructDef<'_>

Returns the struct’s definition.

impl TryFrom<Bytes> for DirectoryItemResponse

type Error = NetworkParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Valuable for DirectoryItemResponse

fn as_value(&self) -> Value<'_>

Converts self into a Value instance.

fn visit(&self, visitor: &mut dyn Visit)

Calls the relevant method on Visit to extract data from self.

fn visit_slice(slice: &[Self], visit: &mut dyn Visit)

where Self: Sized,

Calls Visit::visit_primitive_slice() with self.

impl Eq for DirectoryItemResponse

impl StructuralPartialEq for DirectoryItemResponse