Struct SataOpenFilePacketBody 

pub struct SataOpenFilePacketBody { /* private fields */ }

Available on crate features clients or servers only.

A packet to open a file.

Implementations

impl SataOpenFilePacketBody

pub fn new(path: String, mode_string: String) -> Result<Self, PcfsApiError>

Attempt to construct a new open file packet.

Errors

If the path is longer than 511 bytes. Normally the max path is 512 bytes, but because we need to encode our data as a C-String with a NUL terminator we cannot be longer than 511 bytes.

Consider using relative/mapped paths if possible when dealing with long paths.

We will also error if the mode string is not valid, it requires to be in the format of: (r|w|a)(b+)+ (e.g. starts with either ‘rwa’, and then has either b, or + after that one or more times).

pub fn mode(&self) -> &str

pub fn set_mode(&mut self, new_mode: String) -> Result<(), PcfsApiError>

Update the path to send in this particular create directory packet.

Errors

We will also error if the mode string is not valid, it requires to be in the format of: (r|w|a)(b+)+ (e.g. starts with either ‘rwa’, and then has either b, or + after that one or more times).

pub fn path(&self) -> &str

pub fn set_path(&mut self, new_path: String) -> Result<(), PcfsApiError>

Update the path to send in this particular open file packet.

Errors

If the path is longer than 511 bytes. Normally the max path is 512 bytes, but because we need to encode our data as a C-String with a NUL terminator we cannot be longer than 511 bytes.

Consider using relative/mapped paths if possible when dealing with long paths.

Trait Implementations

impl Clone for SataOpenFilePacketBody

fn clone(&self) -> SataOpenFilePacketBody

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SataOpenFilePacketBody

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

Formats the value using the given formatter.

impl From<&SataOpenFilePacketBody> for Bytes

fn from(value: &SataOpenFilePacketBody) -> Self

Converts to this type from the input type.

impl From<SataOpenFilePacketBody> for Bytes

fn from(value: SataOpenFilePacketBody) -> Self

Converts to this type from the input type.

impl PartialEq for SataOpenFilePacketBody

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

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

Returns the struct’s definition.

impl TryFrom<Bytes> for SataOpenFilePacketBody

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 SataOpenFilePacketBody

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 SataOpenFilePacketBody

impl StructuralPartialEq for SataOpenFilePacketBody