ICU4X
International Components for Unicode
Loading...
Searching...
No Matches
ICU4XUnitsConverterFactory Class Reference

#include <ICU4XUnitsConverterFactory.hpp>

Public Member Functions

std::optional< ICU4XUnitsConverterconverter (const ICU4XMeasureUnit &from, const ICU4XMeasureUnit &to) const
 
ICU4XMeasureUnitParser parser () const
 
 ICU4XUnitsConverterFactory (capi::ICU4XUnitsConverterFactory *i)
 
 ICU4XUnitsConverterFactory ()=default
 
 ICU4XUnitsConverterFactory (ICU4XUnitsConverterFactory &&) noexcept=default
 
ICU4XUnitsConverterFactoryoperator= (ICU4XUnitsConverterFactory &&other) noexcept=default
 

Static Public Member Functions

static diplomat::result< ICU4XUnitsConverterFactory, ICU4XErrorcreate (const ICU4XDataProvider &provider)
 

Detailed Description

An ICU4X Units Converter Factory object, capable of creating converters a [ICU4XUnitsConverter] for converting between two [ICU4XMeasureUnit]s. Also, it can parse the CLDR unit identifier (e.g. meter-per-square-second) and get the [ICU4XMeasureUnit].

See the Rust documentation for ConverterFactory for more information.

Constructor & Destructor Documentation

◆ ICU4XUnitsConverterFactory() [1/3]

ICU4XUnitsConverterFactory::ICU4XUnitsConverterFactory ( capi::ICU4XUnitsConverterFactory * i)
inlineexplicit

◆ ICU4XUnitsConverterFactory() [2/3]

ICU4XUnitsConverterFactory::ICU4XUnitsConverterFactory ( )
default

◆ ICU4XUnitsConverterFactory() [3/3]

ICU4XUnitsConverterFactory::ICU4XUnitsConverterFactory ( ICU4XUnitsConverterFactory && )
defaultnoexcept

Member Function Documentation

◆ converter()

std::optional< ICU4XUnitsConverter > ICU4XUnitsConverterFactory::converter ( const ICU4XMeasureUnit & from,
const ICU4XMeasureUnit & to ) const
inline

Creates a new [ICU4XUnitsConverter] from the input and output [ICU4XMeasureUnit]s. Returns nothing if the conversion between the two units is not possible. For example, conversion between meter and second is not possible.

See the Rust documentation for converter for more information.

◆ create()

diplomat::result< ICU4XUnitsConverterFactory, ICU4XError > ICU4XUnitsConverterFactory::create ( const ICU4XDataProvider & provider)
inlinestatic

Construct a new [ICU4XUnitsConverterFactory] instance.

See the Rust documentation for new for more information.

◆ operator=()

ICU4XUnitsConverterFactory & ICU4XUnitsConverterFactory::operator= ( ICU4XUnitsConverterFactory && other)
defaultnoexcept

◆ parser()

ICU4XMeasureUnitParser ICU4XUnitsConverterFactory::parser ( ) const
inline

Creates a parser to parse the CLDR unit identifier (e.g. meter-per-square-second) and get the [ICU4XMeasureUnit].

See the Rust documentation for parser for more information.

Lifetimes: this must live at least as long as the output.


The documentation for this class was generated from the following file: