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

#include <ICU4XBidiInfo.hpp>

Public Member Functions

size_t paragraph_count () const
 
std::optional< ICU4XBidiParagraphparagraph_at (size_t n) const
 
size_t size () const
 
uint8_t level_at (size_t pos) const
 
 ICU4XBidiInfo (capi::ICU4XBidiInfo *i)
 
 ICU4XBidiInfo ()=default
 
 ICU4XBidiInfo (ICU4XBidiInfo &&) noexcept=default
 
ICU4XBidiInfooperator= (ICU4XBidiInfo &&other) noexcept=default
 

Detailed Description

An object containing bidi information for a given string, produced by for_text() on ICU4XBidi

See the Rust documentation for BidiInfo for more information.

Constructor & Destructor Documentation

◆ ICU4XBidiInfo() [1/3]

ICU4XBidiInfo::ICU4XBidiInfo ( capi::ICU4XBidiInfo * i)
inlineexplicit

◆ ICU4XBidiInfo() [2/3]

ICU4XBidiInfo::ICU4XBidiInfo ( )
default

◆ ICU4XBidiInfo() [3/3]

ICU4XBidiInfo::ICU4XBidiInfo ( ICU4XBidiInfo && )
defaultnoexcept

Member Function Documentation

◆ level_at()

uint8_t ICU4XBidiInfo::level_at ( size_t pos) const
inline

Get the BIDI level at a particular byte index in the full text. This integer is conceptually a unicode_bidi::Level, and can be further inspected using the static methods on ICU4XBidi.

Returns 0 (equivalent to Level::ltr()) on error

◆ operator=()

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

◆ paragraph_at()

std::optional< ICU4XBidiParagraph > ICU4XBidiInfo::paragraph_at ( size_t n) const
inline

Get the nth paragraph, returning None if out of bounds

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

◆ paragraph_count()

size_t ICU4XBidiInfo::paragraph_count ( ) const
inline

The number of paragraphs contained here

◆ size()

size_t ICU4XBidiInfo::size ( ) const
inline

The number of bytes in this full text


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