Enum polars_plan::dsl::function_expr::StringFunction

pub enum StringFunction {
    ConcatHorizontal {
        delimiter: String,
        ignore_nulls: bool,
    },
    ConcatVertical {
        delimiter: String,
        ignore_nulls: bool,
    },
    Contains {
        literal: bool,
        strict: bool,
    },
    CountMatches(bool),
    EndsWith,
    Extract(usize),
    ExtractAll,
    ExtractGroups {
        dtype: DataType,
        pat: String,
    },
    Find {
        literal: bool,
        strict: bool,
    },
    ToInteger(bool),
    LenBytes,
    LenChars,
    Lowercase,
    Replace {
        n: i64,
        literal: bool,
    },
    Reverse,
    PadStart {
        length: usize,
        fill_char: char,
    },
    PadEnd {
        length: usize,
        fill_char: char,
    },
    Slice,
    Head,
    Tail,
    HexEncode,
    HexDecode(bool),
    Base64Encode,
    Base64Decode(bool),
    StartsWith,
    StripChars,
    StripCharsStart,
    StripCharsEnd,
    StripPrefix,
    StripSuffix,
    SplitExact {
        n: usize,
        inclusive: bool,
    },
    SplitN(usize),
    Strptime(DataType, StrptimeOptions),
    Split(bool),
    ToDecimal(usize),
    Titlecase,
    Uppercase,
    ZFill,
    ContainsMany {
        ascii_case_insensitive: bool,
    },
    ReplaceMany {
        ascii_case_insensitive: bool,
    },
    ExtractMany {
        ascii_case_insensitive: bool,
        overlapping: bool,
    },
}

Available on crate feature strings only.

Variants

ConcatHorizontal

Available on crate feature concat_str only.

Fields

delimiter: String

ignore_nulls: bool

ConcatVertical

Available on crate feature concat_str only.

Fields

delimiter: String

ignore_nulls: bool

Contains

Available on crate feature regex only.

Fields

literal: bool

strict: bool

CountMatches(bool)

EndsWith

Extract(usize)

ExtractAll

ExtractGroups

Available on crate feature extract_groups only.

Fields

dtype: DataType

pat: String

Find

Available on crate feature regex only.

Fields

literal: bool

strict: bool

ToInteger(bool)

Available on crate feature string_to_integer only.

LenBytes

LenChars

Lowercase

Replace

Available on crate feature regex only.

Fields

n: i64

literal: bool

Reverse

Available on crate feature string_reverse only.

PadStart

Available on crate feature string_pad only.

Fields

length: usize

fill_char: char

PadEnd

Available on crate feature string_pad only.

Fields

length: usize

fill_char: char

Slice

Head

Tail

HexEncode

Available on crate feature string_encoding only.

HexDecode(bool)

Available on crate feature binary_encoding only.

Base64Encode

Available on crate feature string_encoding only.

Base64Decode(bool)

Available on crate feature binary_encoding only.

StartsWith

StripChars

StripCharsStart

StripCharsEnd

StripPrefix

StripSuffix

SplitExact

Available on crate feature dtype-struct only.

Fields

n: usize

inclusive: bool

SplitN(usize)

Available on crate feature dtype-struct only.

Strptime(DataType, StrptimeOptions)

Available on crate feature temporal only.

Split(bool)

ToDecimal(usize)

Available on crate feature dtype-decimal only.

Titlecase

Available on crate feature nightly only.

Uppercase

ZFill

Available on crate feature string_pad only.

ContainsMany

Available on crate feature find_many only.

Fields

ascii_case_insensitive: bool

ReplaceMany

Available on crate feature find_many only.

Fields

ascii_case_insensitive: bool

ExtractMany

Available on crate feature find_many only.

Fields

ascii_case_insensitive: bool

overlapping: bool

Trait Implementations

impl Clone for StringFunction

fn clone(&self) -> StringFunction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StringFunction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StringFunction

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StringFunction

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

Formats the value using the given formatter.

impl From<StringFunction> for FunctionExpr

fn from(str: StringFunction) -> Self

Converts to this type from the input type.

impl From<StringFunction> for SpecialEq<Arc<dyn SeriesUdf>>

fn from(func: StringFunction) -> Self

Converts to this type from the input type.

impl Hash for StringFunction

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 StringFunction

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for StringFunction

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for StringFunction

impl StructuralPartialEq for StringFunction