Struct cmudict_fast::Cmudict

pub struct Cmudict { /* fields omitted */ }

A dictionary containing words & their pronunciations

Implementations

impl Cmudict

pub fn new<P: AsRef<Path>>(dict: P) -> Result<Cmudict>

Takes a path to a cmudict file and tries to construct a Cmudict struct

Example

use cmudict_fast as cmudict;
use cmudict::Cmudict;

let dict = Cmudict::new("./resources/cmudict.dict")?;

pub fn get(&self, s: &str) -> Option<&[Rule]>

Look for a word in the dictionary, and retrieve it’s pronunciation

Example

use cmudict_fast as cmudict;
use cmudict::{Cmudict, Symbol, Stress};

let dict = Cmudict::new("./resources/cmudict.dict")?;
let rust = dict.get("rust");

assert!(rust.is_some());
assert_eq!(
    rust.unwrap().first().unwrap().pronunciation(),
    &[Symbol::R,
      Symbol::AH(Stress::Primary),
      Symbol::S,
      Symbol::T]
);

Trait Implementations

impl Debug for Cmudict

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

Formats the value using the given formatter.

impl FromStr for Cmudict

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.