pub struct SocketAddr { /* private fields */ }
Expand description
Implementations
sourceimpl SocketAddr
impl SocketAddr
1.61.0 · sourcepub fn from_pathname<P>(path: P) -> Result<SocketAddr> where
P: AsRef<Path>,
pub fn from_pathname<P>(path: P) -> Result<SocketAddr> where
P: AsRef<Path>,
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")));
RunCreating 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());
Runsourcepub 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(())
}
RunAn 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(())
}
Runsourcepub 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(())
}
RunWithout 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(())
}
Runsourcepub fn as_abstract_namespace(&self) -> Option<&[u8]>
Available on Android or Linux only.
pub fn as_abstract_namespace(&self) -> Option<&[u8]>
Returns the contents of this address if it is an abstract namespace without the leading null byte.
Examples
#![feature(unix_socket_abstract)]
use std::os::unix::net::{UnixListener, SocketAddr};
fn main() -> std::io::Result<()> {
let namespace = b"hidden";
let namespace_addr = SocketAddr::from_abstract_namespace(&namespace[..])?;
let socket = UnixListener::bind_addr(&namespace_addr)?;
let local_addr = socket.local_addr().expect("Couldn't get local address");
assert_eq!(local_addr.as_abstract_namespace(), Some(&namespace[..]));
Ok(())
}
Runsourcepub fn from_abstract_namespace(namespace: &[u8]) -> Result<SocketAddr>
Available on Android or Linux only.
pub fn from_abstract_namespace(namespace: &[u8]) -> Result<SocketAddr>
Creates an abstract domain socket address from a namespace
An abstract address does not create a file unlike traditional path-based Unix sockets. The advantage of this is that the address will disappear when the socket bound to it is closed, so no filesystem clean up is required.
The leading null byte for the abstract namespace is automatically added.
This is a Linux-specific extension. See more at unix(7)
.
Errors
This will return an error if the given namespace is too long
Examples
#![feature(unix_socket_abstract)]
use std::os::unix::net::{UnixListener, SocketAddr};
fn main() -> std::io::Result<()> {
let addr = SocketAddr::from_abstract_namespace(b"hidden")?;
let listener = match UnixListener::bind_addr(&addr) {
Ok(sock) => sock,
Err(err) => {
println!("Couldn't bind: {err:?}");
return Err(err);
}
};
Ok(())
}
RunTrait Implementations
sourceimpl Clone for SocketAddr
impl Clone for SocketAddr
sourcefn clone(&self) -> SocketAddr
fn clone(&self) -> SocketAddr
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl RefUnwindSafe for SocketAddr
impl Send for SocketAddr
impl Sync for SocketAddr
impl Unpin for SocketAddr
impl UnwindSafe for SocketAddr
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
Uses borrowed data to replace owned data, usually by cloning. Read more