Utf8String Class

A mutable string stored and serialized in utf-8 format.

Inheritance Hierarchy

SystemObject
Ookii.Jumbo.IOUtf8String

Namespace: Ookii.Jumbo.IO
Assembly: Ookii.Jumbo (in Ookii.Jumbo.dll) Version: 2.0.0

Syntax

C++

Copy

public sealed class Utf8String : IWritable, 
	IEquatable<Utf8String>, IComparable<Utf8String>, IComparable, 
	ICloneable

Public NotInheritable Class Utf8String
	Implements IWritable, IEquatable(Of Utf8String), 
	IComparable(Of Utf8String), IComparable, ICloneable

public ref class Utf8String sealed : IWritable, 
	IEquatable<Utf8String^>, IComparable<Utf8String^>, IComparable, 
	ICloneable

[<SealedAttribute>]
type Utf8String =  
    class
        interface IWritable
        interface IEquatable<Utf8String>
        interface IComparable<Utf8String>
        interface IComparable
        interface ICloneable
    end

The Utf8String type exposes the following members.

Constructors

	Name	Description
	Utf8String	Initializes a new instance of the Utf8String class.
	Utf8String(Byte)	Initializes a new instance of the Utf8String class using the specified utf-8 byte array.
	Utf8String(String)	Initializes a new instance of the Utf8String class using the specified string.
	Utf8String(Utf8String)	Initializes a new instance of the Utf8String class that is a copy of the specified Utf8String.
	Utf8String(Byte, Int32, Int32)	Initializes a new instance of the Utf8String class using the specified utf-8 byte array, index and count.

Top

Properties

	Name	Description
	ByteLength	Gets the number of bytes in the encoded string.
	Capacity	Gets or sets the maximum size, in bytes, of the string this instance can hold without resizing.
	CharLength	Gets the length of the string in characters.

Top

Methods

	Name	Description
	Append(Utf8String)	Appends the specified Utf8String to this instance..
	Append(Byte, Int32, Int32)	Appends a byte array containing utf-8 encoded data to this string.
	Clone	Creates a clone of the current Utf8String.
	CompareTo(Object)	Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
	CompareTo(Utf8String)	Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
	Equals(Object)	Tests this Utf8String for equality with the specified object. (Overrides ObjectEquals(Object).)
	Equals(Utf8String)	Tests this Utf8String for equality with the specified Utf8String.
	GetBytes	Gets the bytes of the utf-8 encoded string.
	GetHashCode	Gets a hash code for this Utf8String. (Overrides ObjectGetHashCode.)
	GetLength	Gets the length of a Utf8String stored in a byte array.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Read	Reads the object from the specified reader.
	Set(Byte)	Sets the value of this Utf8String to the specified byte array.
	Set(String)	Sets the value of this Utf8String to the specified String.
	Set(Utf8String)	Sets the value of this Utf8String to the value of the specified Utf8String.
	Set(Byte, Int32, Int32)	Sets the value of this Utf8String to the specified region of the specified byte array.
	ToString	Gets a string representation of the current Utf8String. (Overrides ObjectToString.)
	Write(BinaryWriter)	Writes the object to the specified writer.
	Write(Stream)	Writes this Utf8String to the specified stream.

Top

Operators

	Name	Description
	Equality	Determines whether two specified Utf8String objects have the same value.
	GreaterThan	Determines whether one specified Utf8String is greater than another specified Utf8String
	GreaterThanOrEqual	Determines whether one specified Utf8String is greater than or equal to another specified Utf8String
	Inequality	Determines whether two specified Utf8String objects have different values.
	LessThan	Determines whether one specified Utf8String is less than another specified Utf8String
	LessThanOrEqual	Determines whether one specified Utf8String is less than or equal to another specified Utf8String

Top

Remarks

Note
Instances of the Utf8String class will not compare in proper lexicographical order if the string contains multi-byte characters. All that is guaranteed is that the ordering is deterministic.

Because this object is mutable you must take care when using it scenarios where immutability is expected, e.g. as a key in a DictionaryTKey, TValue.

Reference

Ookii.Jumbo.IO Namespace