Arangox.Endpoint (Arangox v0.5.5) View Source

Utilities for parsing ArangoDB endpoints.

iex> Endpoint.new("http://localhost:8529")
%Arangox.Endpoint{addr: {:tcp, "localhost", 8529}, ssl?: false}

iex> Endpoint.new("https://localhost:8529")
%Arangox.Endpoint{addr: {:tcp, "localhost", 8529}, ssl?: true}

iex> Endpoint.new("http://unix:/tmp/arangodb.sock")
%Arangox.Endpoint{addr: {:unix, "/tmp/arangodb.sock"}, ssl?: false}

Link to this section Summary

Types

addr()

t()

Functions

new(endpoint)

Parses an endpoint and returns an %Arangox.Endpoint{} struct.

Link to this section Types

addr()

Specs

addr() ::
  {:unix, path :: binary()}
  | {:tcp, host :: binary(), port :: non_neg_integer()}

t()

Specs

t() :: %Arangox.Endpoint{addr: addr(), ssl?: boolean()}

Link to this section Functions

new(endpoint)

Specs

new(Arangox.endpoint()) :: %Arangox.Endpoint{addr: addr(), ssl?: boolean()}

Parses an endpoint and returns an %Arangox.Endpoint{} struct.