StringDecoratorExtensions Class

Definition

Namespace

Cuemon

Assemblies

Cuemon.Core.dll

Source

src/Cuemon.Core/Extensions/StringDecoratorExtensions.cs

Extension methods for the string class hidden behind the IDecorator<T> interface.

public static class StringDecoratorExtensions

Inheritance

object

StringDecoratorExtensions

Examples

StringDecoratorExtensions provides extension methods on Decorator.Enclose for string manipulation including casing conversion, encoding, URI conversion, set operations, and content inspection. This example wraps " Hello World! " and applies ToCasing with LowerCase, UpperCase, and TitleCase modes, converts the string to a byte array and stream with configurable encoding, and extracts the differing portion between "Hello World!" and "Hello Universe!" using Difference. Key steps also include StartsWith checks with multiple candidate strings and ContainsAny for character matching. Console output confirms each transformed value, such as " hello world! " for lower-casing and "Universe!" for the set difference.

using System;
using System.Globalization;
using System.IO;
using System.Text;
using Cuemon;
using Cuemon.Text;

namespace MyApp.Examples;

public class Example
{
    public void Run()
    {

        string value = " Hello World! ";
        var decorator = Decorator.Enclose(value);

        // Change casing via decorator
        string lower = decorator.ToCasing(CasingMethod.LowerCase);          // " hello world! "
        string upper = decorator.ToCasing(CasingMethod.UpperCase);          // " HELLO WORLD! "
        string title = decorator.ToCasing(CasingMethod.TitleCase, new CultureInfo("en-US")); // " Hello World! "

        // Convert to byte array
        byte[] bytes = decorator.ToByteArray(o => o.Encoding = Encoding.UTF8);

        // Convert to stream
        using Stream stream = decorator.ToStream(o => o.Encoding = Encoding.UTF8);

        // Convert to URI
        string url = "https://www.example.com";
        var uriDecorator = Decorator.Enclose(url);
        Uri uri = uriDecorator.ToUri(); // https://www.example.com/

        // Encoding conversions
        string ascii = decorator.ToAsciiEncodedString(o => o.Encoding = Encoding.UTF8); // " Hello World! " (non-ASCII chars replaced with empty)
        string encoded = decorator.ToEncodedString(o =>
        {
            o.TargetEncoding = Encoding.ASCII;
            o.EncoderFallback = new EncoderReplacementFallback("?");
        });

        // StartsWith checks
        bool starts = decorator.StartsWith(" Hello");                     // true
        bool startsIgnore = decorator.StartsWith(StringComparison.OrdinalIgnoreCase, "hello"); // true
        bool startsAny = decorator.StartsWith("Hi", "Hello");             // true

        // Set difference
        var helloDecorator = Decorator.Enclose("Hello World!");
        string diff = helloDecorator.Difference("Hello Universe!"); // "Universe!"

        // ContainsAny for characters
        bool hasChar = decorator.ContainsAny('o', StringComparison.Ordinal);                          // true
        bool hasChars = decorator.ContainsAny(StringComparison.Ordinal, 'x', 'y'); // false
    }
}

Methods

Name	Description
ContainsAny(IDecorator<string>, char, StringComparison)	Returns a value indicating whether the specified find occurs within the enclosed string of the specified decorator.
ContainsAny(IDecorator<string>, StringComparison, params char[])	Returns a value indicating whether the specified values occurs within the enclosed string of the specified decorator object.
Difference(IDecorator<string>, string)	Returns the set difference between second and the enclosed string of the specified decorator or Empty if no difference.
StartsWith(IDecorator<string>, IEnumerable<string>)	Determines whether the beginning of the enclosed string of the specified decorator matches at least one string in the specified sequence of strings.
StartsWith(IDecorator<string>, StringComparison, IEnumerable<string>)	Determines whether the beginning of the enclosed string of the specified decorator matches at least one string in the specified sequence of strings.
StartsWith(IDecorator<string>, StringComparison, params string[])	Determines whether the beginning of the enclosed string of the specified decorator matches at least one string in the specified sequence of strings.
StartsWith(IDecorator<string>, params string[])	Determines whether the beginning of the enclosed string of the specified decorator matches at least one string in the specified sequence of strings.
ToAsciiEncodedString(IDecorator<string>, Action<EncodingOptions>)	Encodes all the characters in the enclosed string of the specified decorator to its ASCII encoded variant.
ToByteArray(IDecorator<string>, Action<EncodingOptions>)	Converts the enclosed string of the specified decorator to its equivalent byte array representation.
ToCasing(IDecorator<string>, CasingMethod)	Converts the enclosed string of the specified decorator to either lowercase, UPPERCASE, Title Case or unaltered.
ToCasing(IDecorator<string>, CasingMethod, CultureInfo)	Converts the enclosed string of the specified decorator to either lowercase, UPPERCASE, Title Case or unaltered using the specified culture.
ToEncodedString(IDecorator<string>, Action<FallbackEncodingOptions>)	Encodes all the characters in the enclosed string of the specified decorator to its encoded string variant.
ToStream(IDecorator<string>, Action<EncodingOptions>)	Converts the enclosed string of the specified decorator to a Stream.
ToUri(IDecorator<string>, UriKind)	Converts the enclosed string of the specified decorator to its equivalent Uri representation.

See Also

IDecorator<T>

Decorator<T>