Astarte.Core.Mapping (astarte_core v1.3.0)

This module handles Interface Mappings using Ecto Changesets

Summary

Types

t()

Functions

changeset(mapping, params, opts)

from_db_result!(db_result)

Deserializes a %Mapping{} from db_result. db_result can be a keyword list or a map.

is_placeholder?(token)

Check if token is a placeholder.

mapping_regex()

normalize_endpoint(endpoint)

Removes all placeholders from an endpoint.

Types

t()

@type t() :: %Astarte.Core.Mapping{
  allow_unset: boolean() | nil,
  database_retention_policy:
    Astarte.Core.Mapping.DatabaseRetentionPolicy.t() | nil,
  database_retention_ttl: integer() | nil,
  description: String.t() | nil,
  doc: String.t() | nil,
  endpoint: String.t() | nil,
  endpoint_id: binary() | nil,
  expiry: integer() | nil,
  explicit_timestamp: boolean() | nil,
  interface_id: binary() | nil,
  path: String.t() | nil,
  reliability: Astarte.Core.Mapping.Reliability.t() | nil,
  retention: Astarte.Core.Mapping.Retention.t() | nil,
  type: Astarte.Core.Mapping.ValueType.t() | nil,
  value_type: Astarte.Core.Mapping.ValueType.t() | nil
}

Functions

changeset(mapping, params, opts)

from_db_result!(db_result)

Deserializes a %Mapping{} from db_result. db_result can be a keyword list or a map.

Returns the %Mapping{} on success, raises on failure

is_placeholder?(token)

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

Check if token is a placeholder.

mapping_regex()

normalize_endpoint(endpoint)

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

Removes all placeholders from an endpoint.