• Home
  • Blog
  • Docs
  • GitHub
Show / Hide Table of Contents

Interface IConfigurationValueCollection

Represents a enumerable collection of configuration values.

Inherited Members
System.Collections.Generic.IEnumerable<System.ValueTuple<System.String, System.String, Snowflake.Configuration.IConfigurationValue>>.GetEnumerator()
System.Collections.IEnumerable.GetEnumerator()
Namespace: Snowflake.Configuration
Assembly: Snowflake.Framework.Primitives.dll
Syntax
public interface IConfigurationValueCollection : IEnumerable<(string section, string option, IConfigurationValue value)>, IEnumerable

Properties

Guid

The unique GUID for this collection of values.

Declaration
Guid Guid { get; }
Property Value
Type Description
System.Guid

Item[IConfigurationSectionDescriptor]

Retrieve a read-only view of configuration values for a given configuration section.

Declaration
IReadOnlyDictionary<string, IConfigurationValue> this[IConfigurationSectionDescriptor descriptor] { get; }
Parameters
Type Name Description
IConfigurationSectionDescriptor descriptor

The descriptor for the section to examine.

Property Value
Type Description
System.Collections.Generic.IReadOnlyDictionary<System.String, IConfigurationValue>

A read-only view of configuration values, keyed on option keys of the provided section.

Item[IConfigurationSectionDescriptor, String]

Retrieve the value in the collection for the given option within the given section. This method retrieves the value in O(1) average time.

Declaration
IConfigurationValue this[IConfigurationSectionDescriptor descriptor, string option] { get; }
Parameters
Type Name Description
IConfigurationSectionDescriptor descriptor

The descriptor for the section to examine.

System.String option

The option key within the section of the configuration.

Property Value
Type Description
IConfigurationValue

The configuration value of the provided option.

Item[Guid]

Retrieves the value in the collection that has the given GUID, or a 3-tuple of null values if not found. This method retrieves the value in O(1) average time.

Declaration
(string section, string option, IConfigurationValue value) this[Guid valueGuid] { get; }
Parameters
Type Name Description
System.Guid valueGuid

The GUID of the configuration value

Property Value
Type Description
System.ValueTuple<System.String, System.String, IConfigurationValue>

The value in the collection that has the given GUID, or a 3-tuple of null values if not found.

Built with ❤️ by @chyyran. Text content licensed under CC-BY-SA 4.0.