Struct DecompositionOptions 

pub struct DecompositionOptions(/* private fields */);

Options for decompound, configuring its search. Available options are found below, as pub consts.

Use DecompositionOptions::empty() to set no options. See the bitflags docs for more.

Implementations

impl DecompositionOptions

pub const TRY_TITLECASE_SUFFIX: Self

In addition to the original suffix being tried, try its titlecased version as well. Does nothing if suffix is already titlecased.

This option is mostly relevant for languages with meaningful capitalization.

use decompound::{decompound, DecompositionError, DecompositionOptions};

let is_valid_single_word = |w: &str| ["Haus", "Boot"].contains(&w);

let word = "Hausboot";

// Without this option
assert_eq!(
    decompound(
        word,
        &is_valid_single_word,
        DecompositionOptions::empty(),
    ).unwrap_err(),
    DecompositionError::NothingValid
);

// With this option
assert_eq!(
    decompound(
        word,
        &is_valid_single_word,
        DecompositionOptions::TRY_TITLECASE_SUFFIX,
    ).unwrap(),
    vec!["Haus", "Boot"]
);

pub const SPLIT_HYPHENATED: Self

Treat hyphenated words as compound words. Its constituents will be returned as a collection of all constituents of the hyphenated word, without any hyphens:

use decompound::{decompound, DecompositionError, DecompositionOptions};

let is_valid_single_word = |w: &str| [
    "room",
    "bed",
    "super",
    "hero",
    "in",
    "side",
].contains(&w);

let word = "bedroom-superhero-inside";

// Without this option
assert_eq!(
    decompound(
        word,
        &is_valid_single_word,
        DecompositionOptions::empty(),
    ).unwrap_err(),
    DecompositionError::NothingValid
);

// With this option
assert_eq!(
    decompound(
        word,
        &is_valid_single_word,
        DecompositionOptions::SPLIT_HYPHENATED,
    ).unwrap(),
    vec!["bed", "room", "super", "hero", "in", "side"]
);

Any error in any of the found subwords will cause the entire operation to fail:

use decompound::{decompound, DecompositionError, DecompositionOptions};

let is_valid_single_word = |w: &str| ["room", "bed"].contains(&w);

assert_eq!(
    decompound(
        "bedroom-error", // 'error' is not a valid word here
        &is_valid_single_word,
        DecompositionOptions::SPLIT_HYPHENATED,
    ).unwrap_err(),
    DecompositionError::NothingValid // Not even `vec!["bed", "room"]`
);

pub const SHATTER: Self

Split into as many constituents as possible. Otherwise, by default, the decomposition with the fewest elements is returned, as that is likeliest to be most desirable. If your use case disagrees, use this option.

Example: Word is both a valid single and compound word

use decompound::{decompound, DecompositionError, DecompositionOptions};

let is_valid_single_word = |w: &str| [
     // These are regular, valid words,
     // virtually guaranteed to be in any dictionary:
    "Entnahme", // "withdrawal"
    "Stelle", // "spot"
    "Elle", // "ell"
    // Not a word in the regular sense, but a plausible occurrence in
    // dictionaries as an abbreviation for `Sankt` (Saint),
    // as in `St. Petersburg`. A party pooper in this case...
    "St",
].contains(&w);

let word = "Entnahmestelle";

// Without this option
assert_eq!(
    decompound(
        word,
        &is_valid_single_word,
        // Option not relevant to example but required for valid German
        // handling:
        DecompositionOptions::TRY_TITLECASE_SUFFIX,
    ).unwrap(),
    vec!["Entnahme", "Stelle"]
);

// With this option
assert_eq!(
    decompound(
        word,
        &is_valid_single_word,
       DecompositionOptions::TRY_TITLECASE_SUFFIX
       | DecompositionOptions::SHATTER,
   ).unwrap(),
  // This is *not* the desired outcome for this term,
  // but it's what this option does:
  vec!["Entnahme", "St", "Elle"]
);

Example: Greedy prefix matching

use decompound::{decompound, DecompositionError, DecompositionOptions};

let is_valid_single_word = |w: &str| [
    "Empfänger",
    "Empfängers", // genetive might be part of dictionary...
    "Station",
    "tat",
    "Ion",
].contains(&w);

let word = "Empfängerstation";

// Without this option
assert_eq!(
    decompound(
        word,
        &is_valid_single_word,
        // Option not relevant to example but required for valid German
        // handling:
        DecompositionOptions::TRY_TITLECASE_SUFFIX,
    ).unwrap(),
    vec!["Empfänger", "Station"]
);

// With this option
assert_eq!(
    decompound(
        word,
        &is_valid_single_word,
       DecompositionOptions::TRY_TITLECASE_SUFFIX
       | DecompositionOptions::SHATTER,
   ).unwrap(),
  // This is *not* the desired outcome for this term,
  // but it's what this option does:
  vec!["Empfängers", "tat", "Ion"]
);

impl DecompositionOptions

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u32) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u32) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Self) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: Self) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: Self, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl DecompositionOptions

pub const fn iter(&self) -> Iter<DecompositionOptions>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<DecompositionOptions>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl AsRef<DecompositionOptions> for DecompositionOptions

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Binary for DecompositionOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl BitAnd for DecompositionOptions

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

type Output = DecompositionOptions

The resulting type after applying the & operator.

impl BitAndAssign for DecompositionOptions

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for DecompositionOptions

fn bitor(self, other: DecompositionOptions) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = DecompositionOptions

The resulting type after applying the | operator.

impl BitOrAssign for DecompositionOptions

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for DecompositionOptions

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = DecompositionOptions

The resulting type after applying the ^ operator.

impl BitXorAssign for DecompositionOptions

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for DecompositionOptions

fn clone(&self) -> DecompositionOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Extend<DecompositionOptions> for DecompositionOptions

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for DecompositionOptions

const FLAGS: &'static [Flag<DecompositionOptions>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> DecompositionOptions

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<DecompositionOptions> for DecompositionOptions

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl IntoIterator for DecompositionOptions

type Item = DecompositionOptions

The type of the elements being iterated over.

type IntoIter = Iter<DecompositionOptions>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for DecompositionOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Not for DecompositionOptions

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = DecompositionOptions

The resulting type after applying the ! operator.

impl Octal for DecompositionOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PublicFlags for DecompositionOptions

type Primitive = u32

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub for DecompositionOptions

fn sub(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = DecompositionOptions

The resulting type after applying the - operator.

impl SubAssign for DecompositionOptions

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for DecompositionOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.