daft.functions.encode#

def encode(expr: Expression, charset: ENCODING_CHARSET) -> Expression:
    """Encode binary or string values using the specified character set.

    If an invalid encoding is encountered, an error will be raised.
    To handle invalid encodings, use `try_encode` instead.

    Args:
        expr (Binary or String Expression): The expression to encode.
        charset (str): The encoding character set (utf-8, base64).

    Returns:
        Expression (Binary Expression): A binary expression with the encoded value.

    Note:
        This inputs either a string or binary and returns a binary.
        If the input value is a string and 'utf-8' is the character set, then it's just a cast to binary.
        If the input value is a binary and 'utf-8' is the character set, we verify the bytes are valid utf-8.
    """
    return Expression._call_builtin_scalar_fn("encode", expr, codec=charset)