# Struct std::os::unix::net::SocketAddr

1.10.0 · source ·

    pub struct SocketAddr { /* private fields */ }

Available on Unix only.
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");

Run

## Implementations§

source§

### impl SocketAddr

1.61.0 · source

#### 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")));

Run

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());

Run
source

#### 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(())
    }

Run

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(())
    }

Run
source

#### 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(())
    }

Run

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(())
    }

Run

## Trait Implementations§

source§

### impl Clone for SocketAddr

source§

#### fn clone(&self) -> SocketAddr

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from `source`. Read more
source§

### impl Debug for SocketAddr

source§

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

Formats the value using the given formatter. Read more
1.70.0 · source§

### impl SocketAddrExt for SocketAddr

Available on Android or Linux only.
source§

#### fn as_abstract_name(&self) -> Option<&[u8]>

Available on Linux and (Linux or Android) only.
Returns the contents of this address if it is in the abstract namespace. Read more
source§

#### fn from_abstract_name<N>(name: N) -> Result<Self>where N: AsRef<[u8]>,

Available on Linux and (Linux or Android) only.
Creates a Unix socket address in the abstract namespace. 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§

source§

### impl<T> Any for Twhere T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for Twhere T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

### impl<T> From<T> for T

source§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

### impl<T, U> Into<U> for Twhere U: From<T>,

source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source§

### impl<T> ToOwned for Twhere T: Clone,

§

#### type Owned = T

The resulting type after obtaining ownership.
source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

### impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

### impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.