KtMongo: MongoDB request DSL/opensavvy.ktmongo.dsl.aggregation.operators/StringValueOperators/trimStart

trimStart

open fun <Context : Any> Value<Context, String?>.trimStart(): Value<Context, String?>(source)

@JvmName(name = "trimStartFieldReceiver")

open fun <Context : Any> Field<Context, String?>.trimStart(): Value<Context, String?>(source)

@JvmName(name = "trimStartPropertyReceiver")

open fun <Context : Any> KProperty1<Context, String?>.trimStart(): Value<Context, String?>(source)

@JvmName(name = "trimStartResultReceiver")

inline fun String?.trimStart(): Value<Any, String?>(source)

Removes whitespace characters, including null, or the specified characters from the beginning of a string.

By default, removes whitespace characters including the null character.

Example

class Document(
    val text: String,
)

collection.aggregate()
    .set {
        Document::text set of(Document::text).trimStart()
    }.toList()

External resources

Official documentation

open fun <Context : Any> Value<Context, String?>.trimStart(vararg characters: Char): Value<Context, String?>(source)

@JvmName(name = "trimStartFieldReceiver")

open fun <Context : Any> Field<Context, String?>.trimStart(vararg characters: Char): Value<Context, String?>(source)

@JvmName(name = "trimStartPropertyReceiver")

open fun <Context : Any> KProperty1<Context, String?>.trimStart(vararg characters: Char): Value<Context, String?>(source)

@JvmName(name = "trimStartResultReceiver")

inline fun String?.trimStart(vararg characters: Char): Value<Any, String?>(source)

Removes the specified characters from the beginning of a string.

Example

class Document(
    val text: String,
)

// Trim both 'g' and 'e' characters from the beginning
collection.aggregate()
    .set {
        Document::text set of(Document::text).trimStart('g', 'e')
    }.toList()

// Trim space, 'g', and 'e' characters from the beginning
collection.aggregate()
    .set {
        Document::text set of(Document::text).trimStart(' ', 'g', 'e')
    }.toList()

External resources

Official documentation

open fun <Context : Any> Value<Context, String?>.trimStart(characters: Value<Context, String?>): Value<Context, String?>(source)

@JvmName(name = "trimStartByField")

open fun <Context : Any> Value<Context, String?>.trimStart(characters: Field<Context, String?>): Value<Context, String?>(source)

@JvmName(name = "trimStartByProperty")

open fun <Context : Any> Value<Context, String?>.trimStart(characters: KProperty1<Context, String?>): Value<Context, String?>(source)

inline fun <Context : Any> Value<Context, String?>.trimStart(characters: String?): Value<Context, String?>(source)

@JvmName(name = "trimStartFieldReceiverByValue")

open fun <Context : Any> Field<Context, String?>.trimStart(characters: Value<Context, String?>): Value<Context, String?>(source)

@JvmName(name = "trimStartFieldReceiverByField")

open fun <Context : Any> Field<Context, String?>.trimStart(characters: Field<Context, String?>): Value<Context, String?>(source)

@JvmName(name = "trimStartFieldReceiverByProperty")

open fun <Context : Any> Field<Context, String?>.trimStart(characters: KProperty1<Context, String?>): Value<Context, String?>(source)

@JvmName(name = "trimStartFieldReceiverByResult")

inline fun <Context : Any> Field<Context, String?>.trimStart(characters: String?): Value<Context, String?>(source)

@JvmName(name = "trimStartPropertyReceiverByValue")

open fun <Context : Any> KProperty1<Context, String?>.trimStart(characters: Value<Context, String?>): Value<Context, String?>(source)

@JvmName(name = "trimStartPropertyReceiverByField")

open fun <Context : Any> KProperty1<Context, String?>.trimStart(characters: Field<Context, String?>): Value<Context, String?>(source)

@JvmName(name = "trimStartPropertyReceiverByProperty")

open fun <Context : Any> KProperty1<Context, String?>.trimStart(characters: KProperty1<Context, String?>): Value<Context, String?>(source)

@JvmName(name = "trimStartPropertyReceiverByResult")

inline fun <Context : Any> KProperty1<Context, String?>.trimStart(characters: String?): Value<Context, String?>(source)

@JvmName(name = "trimStartResultReceiverByValue")

inline fun <Context : Any> String?.trimStart(characters: Value<Context, String?>): Value<Context, String?>(source)

@JvmName(name = "trimStartResultReceiverByField")

inline fun <Context : Any> String?.trimStart(characters: Field<Context, String?>): Value<Context, String?>(source)

@JvmName(name = "trimStartResultReceiverByProperty")

inline fun <Context : Any> String?.trimStart(characters: KProperty1<Context, String?>): Value<Context, String?>(source)

@JvmName(name = "trimStartResultReceiverByResult")

inline fun String?.trimStart(characters: String?): Value<Any, String?>(source)

Removes the specified characters from the beginning of a string.

The characters parameter is a single string that can contain multiple characters to be trimmed. Each character in the string will be removed from the beginning of the input string.

Example

class Document(
    val text: String,
)

// Trim both 'g' and 'e' characters from the beginning
collection.aggregate()
    .set {
        Document::text set of(Document::text).trimStart(characters = of("ge"))
    }.toList()

// Trim space, 'g', and 'e' characters from the beginning
collection.aggregate()
    .set {
        Document::text set of(Document::text).trimStart(characters = of(" ge"))
    }.toList()

External resources

Official documentation