string

string

The text composite of go-composites. A String wraps a Go string and exposes its operations either as plain Go predicates (bool/int) or, when they produce a new value, as a Result — so failures and chaining are values, never panics or nil.

Install

go get github.com/go-composites/string

Usage

package main

import (
    "fmt"

    String "github.com/go-composites/string/src"
    Result "github.com/go-composites/result/src"
    Array  "github.com/go-composites/array/src"
)

func main() {
    s := String.New(String.WithGoString(`Hello World!`))
    fmt.Println(s.ToGoString())        // Hello World!
    fmt.Println(s.Length())            // 12 (rune count)
    fmt.Println(s.Upper().Payload().(String.Interface).ToGoString()) // HELLO WORLD!

    if r := s.Split(` `); !r.HasError() {
        words := r.Payload().(Array.Interface)
        first := words.First().Payload().(String.Interface)
        fmt.Println(first.ToGoString())  // Hello
    }
}

API

Construction & conversion

• New(opts ...Option) Interface — empty String by default.
• WithGoString(string) Option — set the initial value.
• Set(string) Result — set the value; payload is the String.
• ToGoString() string — the underlying Go string.

Inspection (return plain Go values)

Transformation (return a Result wrapping a new String)

Null-Object

Null() returns the never-nil Null-Object String: ToGoString() is "", predicates report false, and value operations return a Result wrapping the null String. IsNull() reports true for it. A sibling package github.com/go-composites/string/src/null (NullString) provides an equivalent Null String over the shared go-composites/null core, with its own New().

License

BSD-3-Clause © the go-composites/string authors.