View Source RedactEx.Configuration.Context (RedactEx v0.1.6-rc.0)

Context for generating a redacting function

Summary

Functions

For fixed-length redacted strings, returns the length of the plaintext to be kept of the original information

Gets the actual redacted part of the string given configuration

Types

@type t() :: %RedactEx.Configuration.Context{
  algorithm: term(),
  except: term(),
  extra: term(),
  fallback_value: term(),
  keep: term(),
  length: term(),
  name: term(),
  needs_fallback_function: term(),
  plaintext_length: term(),
  redacted_length: term(),
  redacted_part: term(),
  redacted_size: term(),
  redactor: term(),
  string_length: term()
}

Functions

Link to this function

get_plaintext_length_redacted_length(string_length, keep, redacted_size)

View Source
@spec get_plaintext_length_redacted_length(
  string_length :: :* | integer(),
  keep :: integer(),
  redacted_size :: integer() | :auto
) :: {nil, nil} | {integer(), integer()}

For fixed-length redacted strings, returns the length of the plaintext to be kept of the original information

Link to this function

get_redactor_string(size, redactor)

View Source
@spec get_redactor_string(size :: nil | integer(), redactor :: char() | any()) ::
  nil | String.t()

Gets the actual redacted part of the string given configuration