Struct base::sys::unix::net::UnixSeqpacket

pub struct UnixSeqpacket(SafeDescriptor);

A Unix SOCK_SEQPACKET socket point to given path

Tuple Fields

0: SafeDescriptor

Implementations

impl UnixSeqpacket

pub fn pair() -> Result<(UnixSeqpacket, UnixSeqpacket)>

Creates a pair of connected SOCK_SEQPACKET sockets.

Both returned file descriptors have the CLOEXEC flag set.

impl UnixSeqpacket

pub fn connect<P: AsRef<Path>>(path: P) -> Result<Self>

Open a SOCK_SEQPACKET connection to socket named by path.

Arguments

• path - Path to SOCK_SEQPACKET socket

Returns

A UnixSeqpacket structure point to the socket

Errors

Return io::Error when error occurs.

pub fn try_clone(&self) -> Result<Self>

Clone the underlying FD.

pub fn get_readable_bytes(&self) -> Result<usize>

Gets the number of bytes that can be read from this socket without blocking.

pub fn next_packet_size(&self) -> Result<usize>

Gets the number of bytes in the next packet. This blocks as if recv were called, respecting the blocking and timeout settings of the underlying socket.

pub fn send(&self, buf: &[u8]) -> Result<usize>

Write data from a given buffer to the socket fd

Arguments

• buf - A reference to the data buffer.

Returns

• usize - The size of bytes written to the buffer.

Errors

Returns error when libc::write failed.

pub fn recv(&self, buf: &mut [u8]) -> Result<usize>

Read data from the socket fd to a given buffer

Arguments

• buf - A mut reference to the data buffer.

Returns

• usize - The size of bytes read to the buffer.

Errors

Returns error when libc::read failed.

pub fn recv_to_vec(&self, buf: &mut Vec<u8>) -> Result<()>

Read data from the socket fd to a given Vec, resizing it to the received packet’s size.

Arguments

• buf - A mut reference to a Vec to resize and read into.

Errors

Returns error when libc::read or get_readable_bytes failed.

pub fn recv_as_vec(&self) -> Result<Vec<u8>>

Read data from the socket fd to a new Vec.

Returns

• vec - A new Vec with the entire received packet.

Errors

Returns error when libc::read or get_readable_bytes failed.

fn set_timeout(&self, timeout: Option<Duration>, kind: c_int) -> Result<()>

pub fn set_read_timeout(&self, timeout: Option<Duration>) -> Result<()>

Sets or removes the timeout for read/recv operations on this socket.

pub fn set_write_timeout(&self, timeout: Option<Duration>) -> Result<()>

Sets or removes the timeout for write/send operations on this socket.

pub fn set_nonblocking(&self, nonblocking: bool) -> Result<()>

Sets the blocking mode for this socket.

Trait Implementations

impl AsRawDescriptor for UnixSeqpacket

fn as_raw_descriptor(&self) -> RawDescriptor

Returns the underlying raw descriptor.

impl Debug for UnixSeqpacket

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UnixSeqpacket

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SafeDescriptor> for UnixSeqpacket

fn from(s: SafeDescriptor) -> Self

Converts to this type from the input type.

impl From<UnixSeqpacket> for SafeDescriptor

fn from(s: UnixSeqpacket) -> Self

Converts to this type from the input type.

impl FromRawDescriptor for UnixSeqpacket

unsafe fn from_raw_descriptor(descriptor: RawDescriptor) -> Self

Safety

impl IntoRawDescriptor for UnixSeqpacket

fn into_raw_descriptor(self) -> RawDescriptor

impl Read for UnixSeqpacket

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Read the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl Serialize for UnixSeqpacket

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<UnixSeqpacket> for ScmSocket<UnixSeqpacket>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(socket: UnixSeqpacket) -> Result<Self>

Performs the conversion.

impl TryFrom<UnixSeqpacket> for Tube

type Error = Error

The type returned in the event of a conversion error.

fn try_from(socket: UnixSeqpacket) -> Result<Self>

Performs the conversion.

impl Write for UnixSeqpacket

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

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

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.