Vllm.Inputs.EmbedsPrompt (VLLM v0.3.0)

Copy Markdown View Source

Schema for a prompt provided via token embeddings.

Summary

Types

t()

Functions

clear(ref)

D.clear() -> None. Remove all items from D.

clear(ref, opts)
clear(ref, arg1, opts)
clear(ref, arg1, arg2, opts)
clear(ref, arg1, arg2, arg3, opts)
clear(ref, arg1, arg2, arg3, arg4, opts)
clear(ref, arg1, arg2, arg3, arg4, arg5, opts)
clear(ref, arg1, arg2, arg3, arg4, arg5, arg6, opts)
clear(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, opts)
clear(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, opts)
copy(ref)

D.copy() -> a shallow copy of D

copy(ref, opts)
copy(ref, arg1, opts)
copy(ref, arg1, arg2, opts)
copy(ref, arg1, arg2, arg3, opts)
copy(ref, arg1, arg2, arg3, arg4, opts)
copy(ref, arg1, arg2, arg3, arg4, arg5, opts)
copy(ref, arg1, arg2, arg3, arg4, arg5, arg6, opts)
copy(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, opts)
copy(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, opts)
fromkeys(ref, iterable, args, opts \\ [])

Create a new dictionary with keys from iterable and values set to value.

get(ref, key, args, opts \\ [])

Return the value for key if key is in the dictionary, else default.

items(ref)

D.items() -> a set-like object providing a view on D's items

items(ref, opts)
items(ref, arg1, opts)
items(ref, arg1, arg2, opts)
items(ref, arg1, arg2, arg3, opts)
items(ref, arg1, arg2, arg3, arg4, opts)
items(ref, arg1, arg2, arg3, arg4, arg5, opts)
items(ref, arg1, arg2, arg3, arg4, arg5, arg6, opts)
items(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, opts)
items(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, opts)
keys(ref)

D.keys() -> a set-like object providing a view on D's keys

keys(ref, opts)
keys(ref, arg1, opts)
keys(ref, arg1, arg2, opts)
keys(ref, arg1, arg2, arg3, opts)
keys(ref, arg1, arg2, arg3, arg4, opts)
keys(ref, arg1, arg2, arg3, arg4, arg5, opts)
keys(ref, arg1, arg2, arg3, arg4, arg5, arg6, opts)
keys(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, opts)
keys(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, opts)
new(args, opts \\ [])

Initialize self. See help(type(self)) for accurate signature.

pop(ref)

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

pop(ref, opts)
pop(ref, arg1, opts)
pop(ref, arg1, arg2, opts)
pop(ref, arg1, arg2, arg3, opts)
pop(ref, arg1, arg2, arg3, arg4, opts)
pop(ref, arg1, arg2, arg3, arg4, arg5, opts)
pop(ref, arg1, arg2, arg3, arg4, arg5, arg6, opts)
pop(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, opts)
pop(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, opts)
popitem(ref, opts \\ [])

Remove and return a (key, value) pair as a 2-tuple.

setdefault(ref, key, args, opts \\ [])

Insert key with a value of default if key is not in the dictionary.

update(ref)

D.update([E, ]**F) -> None. Update D from dict/iterable E and F.

update(ref, opts)
update(ref, arg1, opts)
update(ref, arg1, arg2, opts)
update(ref, arg1, arg2, arg3, opts)
update(ref, arg1, arg2, arg3, arg4, opts)
update(ref, arg1, arg2, arg3, arg4, arg5, opts)
update(ref, arg1, arg2, arg3, arg4, arg5, arg6, opts)
update(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, opts)
update(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, opts)
values(ref)

D.values() -> an object providing a view on D's values

values(ref, opts)
values(ref, arg1, opts)
values(ref, arg1, arg2, opts)
values(ref, arg1, arg2, arg3, opts)
values(ref, arg1, arg2, arg3, arg4, opts)
values(ref, arg1, arg2, arg3, arg4, arg5, opts)
values(ref, arg1, arg2, arg3, arg4, arg5, arg6, opts)
values(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, opts)
values(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, opts)

Types

t()

@opaque t()

Functions

clear(ref)

@spec clear(SnakeBridge.Ref.t()) :: {:ok, term()} | {:error, Snakepit.Error.t()}

D.clear() -> None. Remove all items from D.

Returns

  • term()

clear(ref, opts)

@spec clear(
  SnakeBridge.Ref.t(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}
@spec clear(SnakeBridge.Ref.t(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

clear(ref, arg1, opts)

@spec clear(SnakeBridge.Ref.t(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec clear(SnakeBridge.Ref.t(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

clear(ref, arg1, arg2, opts)

@spec clear(SnakeBridge.Ref.t(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec clear(SnakeBridge.Ref.t(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

clear(ref, arg1, arg2, arg3, opts)

@spec clear(SnakeBridge.Ref.t(), term(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec clear(SnakeBridge.Ref.t(), term(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

clear(ref, arg1, arg2, arg3, arg4, opts)

@spec clear(SnakeBridge.Ref.t(), term(), term(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec clear(SnakeBridge.Ref.t(), term(), term(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

clear(ref, arg1, arg2, arg3, arg4, arg5, opts)

@spec clear(SnakeBridge.Ref.t(), term(), term(), term(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec clear(SnakeBridge.Ref.t(), term(), term(), term(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

clear(ref, arg1, arg2, arg3, arg4, arg5, arg6, opts)

@spec clear(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  keyword()
) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec clear(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term()
) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

clear(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, opts)

@spec clear(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}
@spec clear(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term()
) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

clear(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, opts)

@spec clear(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}

copy(ref)

@spec copy(SnakeBridge.Ref.t()) :: {:ok, term()} | {:error, Snakepit.Error.t()}

D.copy() -> a shallow copy of D

Returns

  • term()

copy(ref, opts)

@spec copy(
  SnakeBridge.Ref.t(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}
@spec copy(SnakeBridge.Ref.t(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

copy(ref, arg1, opts)

@spec copy(SnakeBridge.Ref.t(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec copy(SnakeBridge.Ref.t(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

copy(ref, arg1, arg2, opts)

@spec copy(SnakeBridge.Ref.t(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec copy(SnakeBridge.Ref.t(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

copy(ref, arg1, arg2, arg3, opts)

@spec copy(SnakeBridge.Ref.t(), term(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec copy(SnakeBridge.Ref.t(), term(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

copy(ref, arg1, arg2, arg3, arg4, opts)

@spec copy(SnakeBridge.Ref.t(), term(), term(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec copy(SnakeBridge.Ref.t(), term(), term(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

copy(ref, arg1, arg2, arg3, arg4, arg5, opts)

@spec copy(SnakeBridge.Ref.t(), term(), term(), term(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec copy(SnakeBridge.Ref.t(), term(), term(), term(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

copy(ref, arg1, arg2, arg3, arg4, arg5, arg6, opts)

@spec copy(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  keyword()
) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec copy(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term()
) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

copy(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, opts)

@spec copy(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}
@spec copy(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term()
) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

copy(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, opts)

@spec copy(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}

fromkeys(ref, iterable, args, opts \\ [])

@spec fromkeys(SnakeBridge.Ref.t(), term(), [term()], keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

Create a new dictionary with keys from iterable and values set to value.

Parameters

  • iterable (term())
  • value (term() default: None)

Returns

  • term()

get(ref, key, args, opts \\ [])

@spec get(SnakeBridge.Ref.t(), term(), [term()], keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

Return the value for key if key is in the dictionary, else default.

Parameters

  • key (term())
  • default (term() default: None)

Returns

  • term()

items(ref)

@spec items(SnakeBridge.Ref.t()) :: {:ok, term()} | {:error, Snakepit.Error.t()}

D.items() -> a set-like object providing a view on D's items

Returns

  • term()

items(ref, opts)

@spec items(
  SnakeBridge.Ref.t(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}
@spec items(SnakeBridge.Ref.t(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

items(ref, arg1, opts)

@spec items(SnakeBridge.Ref.t(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec items(SnakeBridge.Ref.t(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

items(ref, arg1, arg2, opts)

@spec items(SnakeBridge.Ref.t(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec items(SnakeBridge.Ref.t(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

items(ref, arg1, arg2, arg3, opts)

@spec items(SnakeBridge.Ref.t(), term(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec items(SnakeBridge.Ref.t(), term(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

items(ref, arg1, arg2, arg3, arg4, opts)

@spec items(SnakeBridge.Ref.t(), term(), term(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec items(SnakeBridge.Ref.t(), term(), term(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

items(ref, arg1, arg2, arg3, arg4, arg5, opts)

@spec items(SnakeBridge.Ref.t(), term(), term(), term(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec items(SnakeBridge.Ref.t(), term(), term(), term(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

items(ref, arg1, arg2, arg3, arg4, arg5, arg6, opts)

@spec items(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  keyword()
) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec items(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term()
) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

items(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, opts)

@spec items(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}
@spec items(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term()
) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

items(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, opts)

@spec items(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}

keys(ref)

@spec keys(SnakeBridge.Ref.t()) :: {:ok, term()} | {:error, Snakepit.Error.t()}

D.keys() -> a set-like object providing a view on D's keys

Returns

  • term()

keys(ref, opts)

@spec keys(
  SnakeBridge.Ref.t(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}
@spec keys(SnakeBridge.Ref.t(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

keys(ref, arg1, opts)

@spec keys(SnakeBridge.Ref.t(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec keys(SnakeBridge.Ref.t(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

keys(ref, arg1, arg2, opts)

@spec keys(SnakeBridge.Ref.t(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec keys(SnakeBridge.Ref.t(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

keys(ref, arg1, arg2, arg3, opts)

@spec keys(SnakeBridge.Ref.t(), term(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec keys(SnakeBridge.Ref.t(), term(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

keys(ref, arg1, arg2, arg3, arg4, opts)

@spec keys(SnakeBridge.Ref.t(), term(), term(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec keys(SnakeBridge.Ref.t(), term(), term(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

keys(ref, arg1, arg2, arg3, arg4, arg5, opts)

@spec keys(SnakeBridge.Ref.t(), term(), term(), term(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec keys(SnakeBridge.Ref.t(), term(), term(), term(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

keys(ref, arg1, arg2, arg3, arg4, arg5, arg6, opts)

@spec keys(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  keyword()
) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec keys(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term()
) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

keys(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, opts)

@spec keys(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}
@spec keys(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term()
) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

keys(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, opts)

@spec keys(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}

new(args, opts \\ [])

@spec new(
  [term()],
  keyword()
) :: {:ok, SnakeBridge.Ref.t()} | {:error, Snakepit.Error.t()}

Initialize self. See help(type(self)) for accurate signature.

Parameters

  • args (term())
  • kwargs (term())

pop(ref)

@spec pop(SnakeBridge.Ref.t()) :: {:ok, term()} | {:error, Snakepit.Error.t()}

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

Returns

  • term()

pop(ref, opts)

@spec pop(
  SnakeBridge.Ref.t(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}
@spec pop(SnakeBridge.Ref.t(), term()) :: {:ok, term()} | {:error, Snakepit.Error.t()}

pop(ref, arg1, opts)

@spec pop(SnakeBridge.Ref.t(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec pop(SnakeBridge.Ref.t(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

pop(ref, arg1, arg2, opts)

@spec pop(SnakeBridge.Ref.t(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec pop(SnakeBridge.Ref.t(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

pop(ref, arg1, arg2, arg3, opts)

@spec pop(SnakeBridge.Ref.t(), term(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec pop(SnakeBridge.Ref.t(), term(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

pop(ref, arg1, arg2, arg3, arg4, opts)

@spec pop(SnakeBridge.Ref.t(), term(), term(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec pop(SnakeBridge.Ref.t(), term(), term(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

pop(ref, arg1, arg2, arg3, arg4, arg5, opts)

@spec pop(SnakeBridge.Ref.t(), term(), term(), term(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec pop(SnakeBridge.Ref.t(), term(), term(), term(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

pop(ref, arg1, arg2, arg3, arg4, arg5, arg6, opts)

@spec pop(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  keyword()
) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec pop(SnakeBridge.Ref.t(), term(), term(), term(), term(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

pop(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, opts)

@spec pop(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}
@spec pop(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term()
) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

pop(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, opts)

@spec pop(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}

popitem(ref, opts \\ [])

@spec popitem(
  SnakeBridge.Ref.t(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

Returns

  • term()

setdefault(ref, key, args, opts \\ [])

@spec setdefault(SnakeBridge.Ref.t(), term(), [term()], keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

Parameters

  • key (term())
  • default (term() default: None)

Returns

  • term()

update(ref)

@spec update(SnakeBridge.Ref.t()) :: {:ok, term()} | {:error, Snakepit.Error.t()}

D.update([E, ]**F) -> None. Update D from dict/iterable E and F.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

Returns

  • term()

update(ref, opts)

@spec update(
  SnakeBridge.Ref.t(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}
@spec update(SnakeBridge.Ref.t(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

update(ref, arg1, opts)

@spec update(SnakeBridge.Ref.t(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec update(SnakeBridge.Ref.t(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

update(ref, arg1, arg2, opts)

@spec update(SnakeBridge.Ref.t(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec update(SnakeBridge.Ref.t(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

update(ref, arg1, arg2, arg3, opts)

@spec update(SnakeBridge.Ref.t(), term(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec update(SnakeBridge.Ref.t(), term(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

update(ref, arg1, arg2, arg3, arg4, opts)

@spec update(SnakeBridge.Ref.t(), term(), term(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec update(SnakeBridge.Ref.t(), term(), term(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

update(ref, arg1, arg2, arg3, arg4, arg5, opts)

@spec update(SnakeBridge.Ref.t(), term(), term(), term(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec update(SnakeBridge.Ref.t(), term(), term(), term(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

update(ref, arg1, arg2, arg3, arg4, arg5, arg6, opts)

@spec update(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  keyword()
) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec update(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term()
) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

update(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, opts)

@spec update(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}
@spec update(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}

update(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, opts)

@spec update(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}

values(ref)

@spec values(SnakeBridge.Ref.t()) :: {:ok, term()} | {:error, Snakepit.Error.t()}

D.values() -> an object providing a view on D's values

Returns

  • term()

values(ref, opts)

@spec values(
  SnakeBridge.Ref.t(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}
@spec values(SnakeBridge.Ref.t(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

values(ref, arg1, opts)

@spec values(SnakeBridge.Ref.t(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec values(SnakeBridge.Ref.t(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

values(ref, arg1, arg2, opts)

@spec values(SnakeBridge.Ref.t(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec values(SnakeBridge.Ref.t(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

values(ref, arg1, arg2, arg3, opts)

@spec values(SnakeBridge.Ref.t(), term(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec values(SnakeBridge.Ref.t(), term(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

values(ref, arg1, arg2, arg3, arg4, opts)

@spec values(SnakeBridge.Ref.t(), term(), term(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec values(SnakeBridge.Ref.t(), term(), term(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

values(ref, arg1, arg2, arg3, arg4, arg5, opts)

@spec values(SnakeBridge.Ref.t(), term(), term(), term(), term(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec values(SnakeBridge.Ref.t(), term(), term(), term(), term(), term(), term()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

values(ref, arg1, arg2, arg3, arg4, arg5, arg6, opts)

@spec values(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  keyword()
) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}
@spec values(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term()
) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

values(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, opts)

@spec values(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}
@spec values(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}

values(ref, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, opts)

@spec values(
  SnakeBridge.Ref.t(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  term(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}