CapyKit/Documentation/Help/T_CapyKit_PoolItem_1.md
Jordan Wages 87bd044b31 Settings Helper + Documentation
The `SettingsHelper` is an agnostic way to access settings values uniformly through code. The accessor methods are controlled by the consumer.

Documentation has been a bit wonky. I changed the max number of version number components allowed, so each new build should not create new changes on every single bit of documentation now.
2024-04-22 18:28:21 -05:00

4.7 KiB

PoolItem<T> Class

A pool item. This class cannot be inherited.

Definition

Namespace: CapyKit
Assembly: CapyKit (in CapyKit.dll) Version: 1.0.0

C#

public sealed class PoolItem<T>

F#

[<SealedAttribute>]
type PoolItem<'T> = class end
InheritanceObject → PoolItem(T)

Type Parameters

The type of the pooled item.

Constructors

PoolItem(T) Initializes a new instance of the PoolItem(T) class with the specified item and index.

Properties

Index Gets the zero-based index of the pooled item.
Item Gets the pooled resource.
Locked Gets a value indicating whether this object is locked or not.
TypeName Gets the name of the Type of the pooled item.

Methods

Equals Determines whether the specified object is equal to the current object.
(Inherited from Object)
Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCode Serves as the default hash function.
(Inherited from Object)
GetType Gets the Type of the current instance.
(Inherited from Object)
MemberwiseClone Creates a shallow copy of the current Object.
(Inherited from Object)
ReleaseLock Releases the lock on the item.
SetLock Sets the lock on the item indicating that it is in use.
ToString Returns a string that represents the current object and its lock state.
(Overrides Object.ToString())

Fields

index The zero-based index of the pooled item.
item The pooled item.
locked A flag indicating whether the item is locked or not.
typeName The name of the pooled item Type.

See Also

Reference

CapyKit Namespace