Struct Chandas

pub struct Chandas { /* private fields */ }

A metrical classifier.

Usage

use vidyut_chandas::{Chandas, MatchType, Vrtta};

let vrttas: Vec<Vrtta> = vec![
    "vasantatilakA\tvrtta\tGGLGLLLGLLGLGG".try_into().unwrap(),
    "mandAkrAntA\tvrtta\tGGGGLLLLLGGLGGLGG".try_into().unwrap(),
    "puzpitAgrA\tvrtta\tLLLLLLGLGLGG/LLLLGLLGLGLGG".try_into().unwrap(),
    "udgatA\tvrtta\tLLGLGLLLGL/LLLLLGLGLG/GLLLLLLGLLG/LLGLGLLLGLGLG".try_into().unwrap()
];
let chandas = Chandas::new(vrttas);

let result = chandas.classify("mAtaH samastajagatAM maDukEwaBAreH");
assert_eq!(result.vrtta().as_ref().unwrap().name(), "vasantatilakA");
assert_eq!(result.match_type(), MatchType::Pada);

Implementations

impl Chandas

pub fn new(vrttas: Vec<Vrtta>) -> Chandas

Creates a new Chandas instance.

pub fn from_text(data: &str) -> Result<Self, Box<dyn Error>>

Creates a new Chandas instance by defining meters from the given text data.

We recommend using this constructor when the program does not have access to the filesystem, e.g. when using this code in WebAssembly.

pub fn from_file(path: &Path) -> Result<Self, Box<dyn Error>>

Creates a new classifier from the given data path.

pub fn vrttas(&self) -> &Vec<Vrtta>

The vrttas available to this classifier.

pub fn classify(&self, text: impl AsRef<str>) -> MatchResult

Classifies the input string against an internal list of meters.

Currently, this function supports only simple samavrtta.

Trait Implementations

impl Clone for Chandas

fn clone(&self) -> Chandas

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Chandas

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

Formats the value using the given formatter.

impl Hash for Chandas

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Chandas

fn eq(&self, other: &Chandas) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Chandas

impl StructuralPartialEq for Chandas