Struct CheckpointMetadata

Optional descriptive data associated with a checkpoint. Provides human-readable information such as timestamp, label, and stage.

Implements

IEquatable<CheckpointMetadata>

Inherited Members

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Namespace: Serenity.Checkpoint.Domain.ValueObjects

Assembly: Serenity.Checkpoint.Domain.dll

Syntax

public readonly struct CheckpointMetadata : IEquatable<CheckpointMetadata>

Constructors

CheckpointMetadata(long, string, string)

Creates a new CheckpointMetadata with the specified values.

Declaration

public CheckpointMetadata(long timestampTicks, string label, string stage)

Parameters

Type	Name	Description
long	timestampTicks	The UTC timestamp in ticks.
string	label	An optional label. Can be null.
string	stage	An optional stage identifier. Can be null.

Fields

Label

An optional human-readable label for the checkpoint.

Declaration

public readonly string Label

Field Value

Type	Description
string

Stage

An optional stage or level identifier.

Declaration

public readonly string Stage

Field Value

Type	Description
string

TimestampTicks

The timestamp when the checkpoint was created (UTC ticks).

Declaration

public readonly long TimestampTicks

Field Value

Type	Description
long

Methods

Equals(CheckpointMetadata)

Declaration

public bool Equals(CheckpointMetadata other)

Parameters

Type	Name	Description
CheckpointMetadata	other

Returns

Type	Description
bool

Equals(object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

ValueType.Equals(object)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

ValueType.GetHashCode()

Now(string, string)

Creates metadata with the current UTC timestamp.

Declaration

public static CheckpointMetadata Now(string label = null, string stage = null)

Parameters

Type	Name	Description
string	label	An optional label.
string	stage	An optional stage identifier.

Returns

Type	Description
CheckpointMetadata	A new CheckpointMetadata with the current timestamp.

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

ValueType.ToString()

Operators

operator ==(CheckpointMetadata, CheckpointMetadata)

Declaration

public static bool operator ==(CheckpointMetadata left, CheckpointMetadata right)

Parameters

Type	Name	Description
CheckpointMetadata	left
CheckpointMetadata	right

Returns

Type	Description
bool

operator !=(CheckpointMetadata, CheckpointMetadata)

Declaration

public static bool operator !=(CheckpointMetadata left, CheckpointMetadata right)

Parameters

Type	Name	Description
CheckpointMetadata	left
CheckpointMetadata	right

Returns

Type	Description
bool

Implements

IEquatable<T>