Struct DatagenDriver

Source
pub struct DatagenDriver { /* private fields */ }
Expand description

Configuration for a data export operation.

Note that this only configures which data is exported. The input provider, usually DatagenProvider, might expose more options about the data itself.

§Examples

use icu_datagen::blob_exporter::*;
use icu_datagen::prelude::*;

DatagenDriver::new()
    .with_keys([icu::list::provider::AndListV1Marker::KEY])
    .with_locales_and_fallback([LocaleFamily::FULL], Default::default())
    .export(
        &DatagenProvider::new_latest_tested(),
        BlobExporter::new_with_sink(Box::new(&mut Vec::new())),
    )
    .unwrap();

Implementations§

Source§

impl DatagenDriver

Source

pub fn new() -> Self

Creates an empty DatagenDriver.

Note that keys and locales need to be set before calling export.

Source

pub fn with_keys(self, keys: impl IntoIterator<Item = DataKey>) -> Self

Sets this driver to generate the given keys.

See icu_datagen::keys, icu_datagen::all_keys, icu_datagen::key and icu_datagen::keys_from_bin.

Source

pub fn with_locales( self, locales: impl IntoIterator<Item = LanguageIdentifier>, ) -> Self

👎Deprecated since 1.5.0: use with_locales_and_fallback or with_locales_no_fallback

Sets this driver to generate the given locales.

Use the langid! macro from the prelude to create an explicit list, or DatagenProvider::locales_for_coverage_levels for CLDR coverage levels.

Source

pub fn with_all_locales(self) -> Self

👎Deprecated since 1.5.0: use with_locales_and_fallback

Sets this driver to generate all available locales.

Source

pub fn with_locales_no_fallback( self, locales: impl IntoIterator<Item = LanguageIdentifier>, _options: NoFallbackOptions, ) -> Self

Sets this driver to generate the given locales assuming no runtime fallback.

Use the langid! macro from the prelude to create an explicit list, or DatagenProvider::locales_for_coverage_levels for CLDR coverage levels.

Source

pub fn with_locales_and_fallback( self, locales: impl IntoIterator<Item = LocaleFamily>, options: FallbackOptions, ) -> Self

Sets this driver to generate the given locales assuming runtime fallback.

Use the langid! macro from the prelude to create an explicit list, or DatagenProvider::locales_for_coverage_levels for CLDR coverage levels.

If there are multiple LocaleFamilys for the same LanguageIdentifier, the last entry in the iterator takes precedence.

Source

pub fn with_fallback_mode(self, fallback: FallbackMode) -> Self

👎Deprecated since 1.5.0: use with_locales_and_fallback or with_locales_no_fallback

Sets the fallback type that the data should be generated for.

If locale fallback is used at runtime, smaller data can be generated.

Source

pub fn with_additional_collations( self, additional_collations: impl IntoIterator<Item = String>, ) -> Self

This option is only relevant if using icu::collator.

By default, the collations big5han, gb2312, and those starting with search are excluded. This method can be used to reennable them.

The special string "search*" causes all search collation tables to be included.

This option is only relevant if using icu::segmenter.

Sets this driver to generate the recommended segmentation models, to the extent required by the chosen data keys.

Source

pub fn with_segmenter_models( self, models: impl IntoIterator<Item = String>, ) -> Self

This option is only relevant if using icu::segmenter.

Sets this driver to generate the given segmentation models, to the extent required by the chosen data keys.

The currently supported dictionary models are

  • cjdict
  • burmesedict
  • khmerdict
  • laodict
  • thaidict

The currently supported LSTM models are

  • Burmese_codepoints_exclusive_model4_heavy
  • Khmer_codepoints_exclusive_model4_heavy
  • Lao_codepoints_exclusive_model4_heavy
  • Thai_codepoints_exclusive_model4_heavy

If a model is not included, the resulting line or word segmenter will apply rule-based segmentation when encountering text in a script that requires the model, which will be incorrect.

If multiple models for the same language and segmentation type (dictionary/LSTM) are listed, the first one will be used.

Source

pub fn export( self, provider: &impl ExportableProvider, sink: impl DataExporter, ) -> Result<(), DataError>

Exports data from the given provider to the given exporter.

See DatagenProvider, make_exportable_provider!, BlobExporter, FileSystemExporter, and BakedExporter.

Trait Implementations§

Source§

impl Clone for DatagenDriver

Source§

fn clone(&self) -> DatagenDriver

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DatagenDriver

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> Filterable for T

Source§

fn filterable( self, filter_name: &'static str, ) -> RequestFilterDataProvider<T, fn(DataRequest<'_>) -> bool>

Creates a filterable data provider with the given name for debugging. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T
where T: Send + Sync,