Codex.Protocol.RateLimit.Window (Codex SDK v0.16.1)

A rate limit window

Summary

Types

t()

Functions

from_map(data)

parse(window)

parse!(window)

schema()

to_map(window)

Types

t()

@type t() :: %Codex.Protocol.RateLimit.Window{
  extra: map(),
  resets_at: (integer() | nil) | nil,
  used_percent: float(),
  window_minutes: (integer() | nil) | nil
}

Functions

from_map(data)

@spec from_map(map()) :: t()

parse(window)

@spec parse(map() | keyword() | t()) ::
  {:ok, t()}
  | {:error,
     {:invalid_rate_limit_window, CliSubprocessCore.Schema.error_detail()}}

parse!(window)

@spec parse!(map() | keyword() | t()) :: t()

schema()

@spec schema() :: Zoi.schema()

to_map(window)

@spec to_map(t()) :: map()