shadow:standard

Class code

Parent class

shadow:standard@Object

Interfaces

shadow:standard@Integer<code>, shadow:standard@CanHash

immutable locked class code

Class code contains the methods that can be called on code values.

Create Summary

Modifiers Return Types Method and Description
public () create()

Destroy Summary

Modifiers Return Types Method and Description
public () destroy()

Method Summary

Modifiers Return Types Method and Description
public readonly locked (code) add(code other)
public readonly locked (code) bitAnd(code other)
public readonly locked (code) bitComplement()
public readonly locked (code) bitOr(code other)
public readonly locked (code) bitRotateLeft(int amount)

Finds the result of left-rotating the bits of the code value by a signed amount which may be positive, negative, or zero.

public readonly locked (code) bitRotateLeft(uint amount)
public readonly locked (code) bitRotateRight(int amount)

Finds the result of right-rotating the bits of the code value by a signed amount which may be positive, negative, or zero.

public readonly locked (code) bitRotateRight(uint amount)
public readonly locked (code) bitShiftLeft(int amount)

Finds the result of left-shifting the bits of the code value by a signed amount which may be positive, negative, or zero.

public readonly locked (code) bitShiftLeft(uint amount)
public readonly locked (code) bitShiftRight(int amount)

Finds the result of right-shifting the bits of the code value by a signed amount which may be positive, negative, or zero.

public readonly locked (code) bitShiftRight(uint amount)
public readonly locked (code) bitXor(code other)
public readonly locked (int) compare(code other)
public readonly (code) copy(AddressMap addresses)
public readonly locked (code) divide(code other)
public readonly locked (boolean) equal(code other)
public readonly locked (code) modulus(code other)
public readonly locked (code) multiply(code other)
public readonly locked (code) subtract(code other)
public readonly locked (byte) toByte()
public readonly locked (code) toCode()
public readonly locked (double) toDouble()
public readonly locked (float) toFloat()
public readonly locked (int) toInt()
public readonly locked (long) toLong()
public readonly locked (code) toLowerCase()

Returns a lower-case version of this code if it represents an upper-case Latin letter.

public readonly locked (short) toShort()
public readonly locked (String) toString()

Returns a String representation of the value, containing this single code value.

public readonly locked (ubyte) toUByte()
public readonly locked (uint) toUInt()
public readonly locked (ulong) toULong()
public readonly locked (ushort) toUShort()
public readonly locked (code) toUpperCase()

Returns an upper-case version of this code if it represents a lower-case Latin letter.

Property Summary

Modifiers Return Types Method and Description
public readonly get locked (ulong) hash()

Finds a hash value for the current value.

Create Detail

create

public create() => ()

Destroy Detail

destroy

public destroy() => ()

Method Detail

add

public readonly locked add(code other) => (code)

bitAnd

public readonly locked bitAnd(code other) => (code)

bitComplement

public readonly locked bitComplement() => (code)

bitOr

public readonly locked bitOr(code other) => (code)

bitRotateLeft

public readonly locked bitRotateLeft(int amount) => (code)

Finds the result of left-rotating the bits of the code value by a signed amount which may be positive, negative, or zero.

Parameters

amount - bits to rotate

Returns

rotated value

bitRotateLeft

public readonly locked bitRotateLeft(uint amount) => (code)

bitRotateRight

public readonly locked bitRotateRight(int amount) => (code)

Finds the result of right-rotating the bits of the code value by a signed amount which may be positive, negative, or zero.

Parameters

amount - bits to rotate

Returns

rotated value

bitRotateRight

public readonly locked bitRotateRight(uint amount) => (code)

bitShiftLeft

public readonly locked bitShiftLeft(int amount) => (code)

Finds the result of left-shifting the bits of the code value by a signed amount which may be positive, negative, or zero.

Parameters

amount - bits to shift

Returns

shifted value

bitShiftLeft

public readonly locked bitShiftLeft(uint amount) => (code)

bitShiftRight

public readonly locked bitShiftRight(int amount) => (code)

Finds the result of right-shifting the bits of the code value by a signed amount which may be positive, negative, or zero.

Parameters

amount - bits to shift

Returns

shifted value

bitShiftRight

public readonly locked bitShiftRight(uint amount) => (code)

bitXor

public readonly locked bitXor(code other) => (code)

compare

public readonly locked compare(code other) => (int)

copy

public readonly copy(AddressMap addresses) => (code)

divide

public readonly locked divide(code other) => (code)

equal

public readonly locked equal(code other) => (boolean)

modulus

public readonly locked modulus(code other) => (code)

multiply

public readonly locked multiply(code other) => (code)

subtract

public readonly locked subtract(code other) => (code)

toByte

public readonly locked toByte() => (byte)

toCode

public readonly locked toCode() => (code)

toDouble

public readonly locked toDouble() => (double)

toFloat

public readonly locked toFloat() => (float)

toInt

public readonly locked toInt() => (int)

toLong

public readonly locked toLong() => (long)

toLowerCase

public readonly locked toLowerCase() => (code)

Returns a lower-case version of this code if it represents an upper-case Latin letter. Otherwise, it returns the code unchanged. Note that this method does not currently support accented Latin characters or non-Latin characters.

Returns

lower-case version

toShort

public readonly locked toShort() => (short)

toString

public readonly locked toString() => (String)

Returns a String representation of the value, containing this single code value.

Returns

String representation

toUByte

public readonly locked toUByte() => (ubyte)

toUInt

public readonly locked toUInt() => (uint)

toULong

public readonly locked toULong() => (ulong)

toUShort

public readonly locked toUShort() => (ushort)

toUpperCase

public readonly locked toUpperCase() => (code)

Returns an upper-case version of this code if it represents a lower-case Latin letter. Otherwise, it returns the code unchanged. Note that this method does not currently support accented Latin characters or non-Latin characters.

Returns

upper-case version

Property Detail

hash

public readonly get locked hash() => (ulong)

Finds a hash value for the current value.

Returns

hash value