pub struct SocketAddr { /* private fields */ }
Expand description
An address associated with a Unix socket.
§Examples
use std::os::unix::net::UnixListener;
let socket = match UnixListener::bind("/tmp/sock") {
Ok(sock) => sock,
Err(e) => {
println!("Couldn't bind: {e:?}");
return
}
};
let addr = socket.local_addr().expect("Couldn't get local address");
Implementations§
source§impl SocketAddr
impl SocketAddr
1.61.0 · sourcepub fn from_pathname<P>(path: P) -> Result<SocketAddr, Error>
pub fn from_pathname<P>(path: P) -> Result<SocketAddr, Error>
Constructs a SockAddr
with the family AF_UNIX
and the provided path.
§Errors
Returns an error if the path is longer than SUN_LEN
or if it contains
NULL bytes.
§Examples
use std::os::unix::net::SocketAddr;
use std::path::Path;
let address = SocketAddr::from_pathname("/path/to/socket")?;
assert_eq!(address.as_pathname(), Some(Path::new("/path/to/socket")));
Creating a SocketAddr
with a NULL byte results in an error.
use std::os::unix::net::SocketAddr;
assert!(SocketAddr::from_pathname("/path/with/\0/bytes").is_err());
1.10.0 · sourcepub fn is_unnamed(&self) -> bool
pub fn is_unnamed(&self) -> bool
Returns true
if the address is unnamed.
§Examples
A named address:
use std::os::unix::net::UnixListener;
fn main() -> std::io::Result<()> {
let socket = UnixListener::bind("/tmp/sock")?;
let addr = socket.local_addr().expect("Couldn't get local address");
assert_eq!(addr.is_unnamed(), false);
Ok(())
}
An unnamed address:
use std::os::unix::net::UnixDatagram;
fn main() -> std::io::Result<()> {
let socket = UnixDatagram::unbound()?;
let addr = socket.local_addr().expect("Couldn't get local address");
assert_eq!(addr.is_unnamed(), true);
Ok(())
}
1.10.0 · sourcepub fn as_pathname(&self) -> Option<&Path>
pub fn as_pathname(&self) -> Option<&Path>
Returns the contents of this address if it is a pathname
address.
§Examples
With a pathname:
use std::os::unix::net::UnixListener;
use std::path::Path;
fn main() -> std::io::Result<()> {
let socket = UnixListener::bind("/tmp/sock")?;
let addr = socket.local_addr().expect("Couldn't get local address");
assert_eq!(addr.as_pathname(), Some(Path::new("/tmp/sock")));
Ok(())
}
Without a pathname:
use std::os::unix::net::UnixDatagram;
fn main() -> std::io::Result<()> {
let socket = UnixDatagram::unbound()?;
let addr = socket.local_addr().expect("Couldn't get local address");
assert_eq!(addr.as_pathname(), None);
Ok(())
}
Trait Implementations§
1.10.0 · source§impl Clone for SocketAddr
impl Clone for SocketAddr
source§fn clone(&self) -> SocketAddr
fn clone(&self) -> SocketAddr
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read more1.10.0 · source§impl Debug for SocketAddr
impl Debug for SocketAddr
1.70.0 · source§impl SocketAddrExt for SocketAddr
Available on Android or Linux only.
impl SocketAddrExt for SocketAddr
Available on Android or Linux only.
source§fn as_abstract_name(&self) -> Option<&[u8]>
fn as_abstract_name(&self) -> Option<&[u8]>
Returns the contents of this address if it is in the abstract namespace. Read more
source§fn from_abstract_name<N>(name: N) -> Result<SocketAddr, Error>
fn from_abstract_name<N>(name: N) -> Result<SocketAddr, Error>
Creates a Unix socket address in the abstract namespace. Read more
Auto Trait Implementations§
impl Freeze for SocketAddr
impl RefUnwindSafe for SocketAddr
impl Send for SocketAddr
impl Sync for SocketAddr
impl Unpin for SocketAddr
impl UnwindSafe for SocketAddr
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)