Skip to main content

Module policy_key_set

Module policy_key_set 

Source
Expand description

Finite policy-key sets for formatter policy.

This module owns the typed PolicyKeySet model used by policy configuration. The public universe contains policy keys. Each key is one variation-sequence base plus one domain:

  • ordinary, for non-keycap selector slots
  • keycap-character, where the same base is followed by U+20E3 COMBINING ENCLOSING KEYCAP

§Examples

use evfmt::{FormatResult, Policy, PolicyKeySet, format_text, policy_key_set};

let policy = Policy::default()
    .with_prefer_bare(policy_key_set::ASCII | PolicyKeySet::singleton('\u{00A9}'));

assert_eq!(format_text("\u{00A9}", &policy), FormatResult::Unchanged);

Structs§

PolicyKeySet
A finite set of formatter policy keys.

Constants§

ASCII
ASCII variation-sequence bases (#, *, and 0-9) as non-keycap policy keys.
EMOJI_DEFAULTS
Emoji-default variation-sequence bases as non-keycap policy keys.
KEYCAP_EMOJI_DEFAULTS
Emoji-default variation-sequence bases as keycap-character policy keys.
KEYCAP_RGI
RGI emoji keycap bases (#, *, 0-9) as keycap-character policy keys.
KEYCAP_TEXT_DEFAULTS
Text-default variation-sequence bases as keycap-character policy keys.
KEYCAP_VARIATION_BASES
Every keycap-character policy key for a variation-sequence base.
TEXT_DEFAULTS
Text-default variation-sequence bases as non-keycap policy keys.
VARIATION_BASES
Every non-keycap policy key for a variation-sequence base.

Functions§

is_variation_sequence_character
Return whether ch is an eligible variation-sequence base character.