struct Socket::UNIXAddress

Overview

UNIX address representation.

Holds the local path of an UNIX address, usually coming from an opened connection (e.g. Socket#local_address, Socket#receive).

Example:

require "socket"

Socket::UNIXAddress.new("/tmp/my.sock")

Defined in:

socket/address.cr

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from struct Socket::Address

==(other) ==, family : Family family, size : Int32 size, to_unsafe : Pointer(LibC::Sockaddr) to_unsafe

Constructor methods inherited from struct Socket::Address

from(sockaddr : Pointer(LibC::Sockaddr), addrlen) : Address from, new(family : Family, size : Int32) new

Class methods inherited from struct Socket::Address

parse(uri : URI)
parse(uri : String)
parse

Instance methods inherited from struct Struct

==(other) : Bool ==, hash(hasher) hash, inspect(io : IO) : Nil inspect, pretty_print(pp) : Nil pretty_print, to_s(io : IO) : Nil to_s

Instance methods inherited from struct Value

==(other : JSON::Any)
==(other : YAML::Any)
==(other)
==
, dup dup

Instance methods inherited from class Object

! : Bool !, !=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)
===(other : YAML::Any)
===(other)
===
, =~(other) =~, as(type : Class) as, as?(type : Class) as?, class class, dup dup, hash
hash(hasher)
hash
, inspect(io : IO) : Nil
inspect : String
inspect
, is_a?(type : Class) : Bool is_a?, itself itself, nil? : Bool nil?, not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, responds_to?(name : Symbol) : Bool responds_to?, tap(&) tap, to_json(io : IO)
to_json
to_json
, to_pretty_json(indent : String = " ")
to_pretty_json(io : IO, indent : String = " ")
to_pretty_json
, to_s : String
to_s(io : IO) : Nil
to_s
, to_yaml(io : IO)
to_yaml
to_yaml
, try(&) try, unsafe_as(type : T.class) forall T unsafe_as

Constructor methods inherited from class Object

from_json(string_or_io, root : String) : self
from_json(string_or_io) : self
from_json
, from_yaml(string_or_io : String | IO) : self from_yaml

Constructor Detail

def self.from(sockaddr : Pointer(LibC::Sockaddr), addrlen) : UNIXAddress #

Creates an UNIXSocket from the internal OS representation.


[View source]
def self.new(path : String) #

[View source]
def self.parse(uri : URI) : UNIXAddress #

Parses a Socket::UNIXAddress from an URI.

It expects the URI to include :// where scheme as well as any additional URI components (such as fragment or query) are ignored.

If host is not empty, it will be prepended to #path to form a relative path.

require "socket"

Socket::UNIXAddress.parse("unix:///foo.sock") # => Socket::UNIXAddress.new("/foo.sock")
Socket::UNIXAddress.parse("unix://foo.sock")  # => Socket::UNIXAddress.new("foo.sock")

[View source]

Class Method Detail

def self.parse(uri : String) #

Parses a Socket::UNIXAddress from an URI.

It expects the URI to include :// where scheme as well as any additional URI components (such as fragment or query) are ignored.

If host is not empty, it will be prepended to #path to form a relative path.

require "socket"

Socket::UNIXAddress.parse("unix:///foo.sock") # => Socket::UNIXAddress.new("/foo.sock")
Socket::UNIXAddress.parse("unix://foo.sock")  # => Socket::UNIXAddress.new("foo.sock")

[View source]

Instance Method Detail

def ==(other : UNIXAddress) #

[View source]
def path : String #

[View source]
def to_s(io : IO) : Nil #
Description copied from struct Struct

Same as #inspect(io).


[View source]
def to_unsafe : Pointer(LibC::Sockaddr) #

[View source]