GroundPlane.Contracts.RevisionRef (GroundPlane Contracts v0.1.0)

Opaque revision reference.

Summary

t()

new(segment)

new(left, right)

parse(value)

valid?(value)

@type t() :: %GroundPlane.Contracts.RevisionRef{
  ref: String.t(),
  segments: [String.t()]
}

@spec new(String.t()) :: {:ok, t()} | {:error, term()}

@spec new(String.t(), String.t()) :: {:ok, t()} | {:error, term()}

@spec new(String.t(), String.t(), String.t()) :: {:ok, t()} | {:error, term()}

@spec new(String.t(), String.t(), String.t(), String.t()) ::
  {:ok, t()} | {:error, term()}

@spec parse(String.t()) :: {:ok, t()} | {:error, term()}

@spec to_string(t()) :: String.t()

@spec valid?(term()) :: boolean()