Search Results for

    Show / Hide Table of Contents

    Class NotUsed

    This type is used in generic type signatures wherever the actual value is of no importance. It is a combination of F#’s 'unit' and C#’s 'void', which both have different issues when used from the other language. An example use-case is the materialized value of an Akka Stream for cases where no result shall be returned from materialization.

    Inheritance
    object
    NotUsed
    Implements
    IEquatable<NotUsed>
    IComparable<NotUsed>
    Inherited Members
    object.Equals(object, object)
    object.GetType()
    object.ReferenceEquals(object, object)
    Namespace: Akka
    Assembly: Akka.dll
    Syntax
    [Serializable]
    public sealed class NotUsed : IEquatable<NotUsed>, IComparable<NotUsed>

    Fields

    | Edit this page View Source

    Instance

    The singleton instance of NotUsed.

    Declaration
    public static readonly NotUsed Instance
    Field Value
    Type Description
    NotUsed

    Methods

    | Edit this page View Source

    CompareTo(NotUsed?)

    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.

    Declaration
    public int CompareTo(NotUsed? other)
    Parameters
    Type Name Description
    NotUsed other

    An object to compare with this instance.

    Returns
    Type Description
    int

    A value that indicates the relative order of the objects being compared. The return value has these meanings:

    Value Meaning
    Less than zero This instance precedes other in the sort order.
    Zero This instance occurs in the same position in the sort order as other.
    Greater than zero This instance follows other in the sort order.
    | Edit this page View Source

    Equals(NotUsed?)

    Indicates whether the current object is equal to another object of the same type.

    Declaration
    public bool Equals(NotUsed? other)
    Parameters
    Type Name Description
    NotUsed other

    An object to compare with this object.

    Returns
    Type Description
    bool

    true if the current object is equal to the other parameter; otherwise, false.

    | Edit this page View Source

    Equals(object?)

    Determines whether the specified object is equal to the current object.

    Declaration
    public override bool Equals(object? obj)
    Parameters
    Type Name Description
    object obj

    The object to compare with the current object.

    Returns
    Type Description
    bool

    true if the specified object is equal to the current object; otherwise, false.

    Overrides
    object.Equals(object)
    | Edit this page View Source

    GetHashCode()

    Serves as the default hash function.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    int

    A hash code for the current object.

    Overrides
    object.GetHashCode()
    | Edit this page View Source

    ToString()

    Returns a string that represents the current object.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string

    A string that represents the current object.

    Overrides
    object.ToString()

    Implements

    IEquatable<T>
    IComparable<T>

    Extension Methods

    ObjectExtensions.IsDefaultForType<T>(T)
    ObjectExtensions.AsOption<T>(T)
    Extensions.AsInstanceOf<T>(object)
    In this article
    • githubEdit this page
    • View Source
    Back to top
    Contribute
    • Project Chat
    • Discussion Forum
    • Source Code
    Support
    • Akka.NET Support Plans
    • Akka.NET Observability Tools
    • Akka.NET Training & Consulting
    Maintained By
    • Petabridge - The Akka.NET Company
    • Learn Akka.NET