Jido.VFS.Visibility (Jido.VFS v1.0.0)

View Source

Helpers for working with portable and adapter-specific visibility values.

Summary

Functions

Guards a visibility value, returning the portable visibility or :error.

Returns true when the visibility is one of the portable values.

Types

custom()

@type custom() :: term()

portable()

@type portable() :: :public | :private

t()

@type t() :: portable() | custom()

Functions

guard_portable(visibility)

@spec guard_portable(any()) :: {:ok, portable()} | :error

Guards a visibility value, returning the portable visibility or :error.

portable?(arg1)

@spec portable?(any()) :: boolean()

Returns true when the visibility is one of the portable values.