View Source Appwrite.Consts.ImageGravity (appwrite v0.1.9)

Provides constants and validation functions for image gravity (positioning) values.

This module defines various image gravity options, such as center, top-left, bottom-right, etc. Helper functions are included to validate these gravity values, ensuring only recognized positioning options are used.

Summary

Functions

is_valid_gravity?(gravity)

Returns true if the given gravity is a valid image gravity value.

valid_gravity(image_gravity)

Guard clause to check if a given image gravity is a valid image gravity code.

validate_gravity(gravity)

Validates the given gravity and returns {:ok, gravity} if it is valid, or {:error, "Invalid image gravity"} otherwise.

validate_gravity!(gravity)

Returns the given gravity if it is valid. Raises an ArgumentError if the gravity is invalid.

Functions

is_valid_gravity?(gravity)

@spec is_valid_gravity?(String.t()) :: boolean()

Returns true if the given gravity is a valid image gravity value.

Examples 

iex> ImageGravity.is_valid_gravity?("top-left")
true

iex> ImageGravity.is_valid_gravity?("middle")
false

valid_gravity(image_gravity)

(macro) 
@spec valid_gravity(String.t()) :: boolean()

Guard clause to check if a given image gravity is a valid image gravity code.

Examples 

iex> ImageGravity.valid_gravity("center")
true

iex> ImageGravity.valid_gravity("down_right")
false

validate_gravity(gravity)

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

Validates the given gravity and returns {:ok, gravity} if it is valid, or {:error, "Invalid image gravity"} otherwise.

Examples 

iex> ImageGravity.validate_gravity("top-right")
{:ok, "top-right"}

iex> ImageGravity.validate_gravity("middle")
{:error, "Invalid image gravity"}

validate_gravity!(gravity)

@spec validate_gravity!(String.t()) :: String.t()

Returns the given gravity if it is valid. Raises an ArgumentError if the gravity is invalid.

Examples 

iex> ImageGravity.validate_gravity!("center")
"center"

iex> ImageGravity.validate_gravity!("middle")
** (ArgumentError) Invalid image gravity: "middle"