• Avalanche.Core
Search Results for

    Show / Hide Table of Contents
    • Avalanche.Accessor
      • Introduction
      • IAccessor
        • IAccessor
        • IListAccessor
        • IMapAccessor
        • IRecordAccessor
        • IContentAccessor
        • IOneOfAccessor
        • IAnyAccessor
      • .Net
        • Introduction
        • IList<T>
        • IDictionary<K,V>
        • FieldInfo
        • OneOfAttribute
        • StructLayoutAttribute
        • Class
      • Protobuf
        • Introduction
      • Articles
        • Dependency Injection
        • AccessorMessages
    • Avalanche.Binding
      • Introduction
    • Avalanche.Core
      • License
    • Avalanche.DataType
      • Introduction
      • DataType
        • IDataType
        • IListType
        • IMapType
        • IRecordType
        • IFieldType
        • IOneOfType
        • IAnyType
        • IStringType
        • IValueType
        • IIntegerType
        • IEnumerationType
        • IRealType
      • .Net
        • Introduction
        • IList<T>
        • IDictionary<K,V>
        • FieldInfo
        • Enum
        • OneOfAttribute
        • StructLayoutAttribute
        • Class
      • Protobuf
        • Introduction
      • Articles
        • DataTypeRequest
        • PrintTree
        • DataTypeMessages
    • Avalanche.Emit
      • Introduction
      • TypeBuilder
      • ConstructorBuilder
      • MethodBuilder
      • PropertyBuilder
      • FieldBuilder
      • Emit
      • Utilities
    • Avalanche.FileSystem
      • Introduction
      • Abstractions
        • IFileSystem
          • IFileSystemBrowse
          • IFileSystemCreateDirectory
          • IFileSystemDelete
          • IFileSystemFileAttribute
          • IFileSystemMount
          • IFileSystemMove
          • IFileSystemObserve
          • IFileSystemOpen
        • IEvent
        • IEntry
        • IOption
        • IToken
      • FileSystem
      • VirtualFileSystem
      • MemoryFileSystem
      • EmbeddedFileSystem
      • HttpFileSystem
      • Decoration
      • IFileProvider
      • Events
      • Utilities
        • Dispose
        • File Scanner
        • Visit Tree
        • File Operation
    • Avalanche.Identity
      • Introduction
      • Identity
      • IdentityParts
      • IdentityInterner
      • IdentityComparer
      • Print Tree
      • IdentityAccessors
        • Introduction
        • TypeName
    • Avalanche.Localization
      • Introduction
      • Localization
      • LocalizationFile
      • LocalizationFiles
      • LocalizationFileSystem
      • LocalizationFileFormat
      • LocalizationLine
      • LocalizationLines
      • TemplateFormat
      • CultureProvider
      • FallbackCultureProvider
      • ResourceManager
      • LocalizationError
      • Microsoft.Extensions
        • Introduction
        • DependencyInjection
        • FileProvider
        • Logging
        • ITextLocalizer
        • IFileLocalizer
        • Localization
      • Asp.Net
        • Introduction
        • Supplying localization
        • Inject to pages
        • Culture Assigned
        • Minimalistic Api
        • Diagnostics
      • Pluralization
        • Introduction
        • Multiple plural parameters
        • Custom PluralRules
        • Invariant Culture
        • Unit Prefix
        • IPluralRule
        • IPluralNumber
        • IPluralRules
        • CLDRs
        • Unicode.CLDR40
        • Unicode.CLDR41
        • Unicode.CLDR42
      • Articles
        • Alphabet localization
        • Benchmarks
        • Caching
        • Class Library
        • Demo
        • Diagnostics
        • Embedded resources
        • Emplacement
        • File localization
        • Text localization
        • Printing templates
    • Avalanche.Message
      • Introduction
      • IMessage
      • IMessageProvider
      • IMessageDescription
      • IMessageDescriptions
      • MessageLevel
      • Message printing
      • Messages and Exceptions
      • Microsoft.Extensions
        • DependencyInjection
      • Articles
        • Aggregate Messages
        • Localization
        • Logging
        • Validation
    • Avalanche.Service
      • Introduction
      • Service
        • Introduction
        • IService
        • IServiceDisposable
        • IServiceDecoration
        • IServiceCast
        • IServiceObservable
        • IServiceContainer
        • Construction
        • Query
        • CancellationToken
        • CachePolicy
        • Scope
      • Handler
        • Introduction
        • IHandler
        • IHandlerCast
        • IHandlerDecoration
        • IHandlerWithOrder
        • CancellationToken
        • Cyclicity
        • Delegates
        • Invokable
        • ExportAttribute
        • OrderAttribute
        • PrintTree
        • Recursion
      • Query
        • Introduction
        • IQuery
        • IQueryCast
        • IQueryDecoration
      • Entry
        • Introduction
        • IEntry
        • IEntryCast
        • IEntryDecoration
        • IEntryObservable
        • IEntryVisitable
        • EntryState
      • Request
        • Introduction
        • IRequest
        • IRequestFor
        • IRequestToBeCached
        • IRequestToBeDisposed
        • RequestAttribute
        • ContextParameterAttribute
        • Print Tree
      • Dependency Injection
        • Introduction
        • Asp.Net
        • ServiceRequest<T>
        • Decorating a service
        • Handler
        • CachePolicy
        • CancellationToken
        • QueryLogger
      • Examples
        • NodeCount
        • Expression
        • Mapper
      • Articles
        • Benchmarks
        • Error Handling
        • ServiceMessages
    • Avalanche.StatusCode
      • Introduction
      • HResult
        • Introduction
        • HResult.Facilities
        • BasicMessages
        • RpcMessages
        • DispatchMessages
        • ItfMessages
        • Win32Messages
        • ClrMessages
      • System
        • Introduction
        • AccessControlMessages
        • AggregateMessages
        • AppDomainMessages
        • ArgumentMessages
        • ArgumentNullMessages
        • ArgumentOutOfRangeMessages
        • ArithmeticMessages
        • ArrayMessages
        • AssemblyMessages
        • BadImageFormatMessages
        • CodeContractMessages
        • CodePageMessages
        • CollectionsMessages
        • CompilerServiceMessages
        • CryptographyMessages
        • CultureMessages
        • DiagnosticsMessages
        • EventSourceMessages
        • ExecutionEngineMessages
        • FormatMessages
        • HostProtectionMessages
        • IOMessages
        • IndexOutOfRangeMessages
        • InteropServiceMessages
        • InvalidCastMessages
        • InvalidOperationMessages
        • IsolatedStorageMessages
        • LazyMessages
        • MarshalerMessages
        • MemoryMessages
        • MiscellaneousMessages
        • NotImplementedMessages
        • NotSupportedMessages
        • ObjectDisposedMessages
        • OperationCanceledMessages
        • OverflowMessages
        • PlatformMessages
        • PolicyMessages
        • PrincipalMessages
        • ProgramMessages
        • ReferenceMessages
        • ReflectionMessages
        • RegionMessages
        • RemotingMessages
        • ResourcesMessages
        • SecurityMessages
        • SerializationMessages
        • StackMessages
        • TaskMessages
        • TextMessages
        • ThreadingMessages
        • TimeZoneMessages
        • TypeMessages
        • XmlMessages
      • HttpStatusCode
      • OpcUaStatusCode
    • Avalanche.Template
      • Introduction
      • TemplateFormats
      • ITemplatePrintable
      • ITemplateFormatPrintable
      • ITemplateText
      • ITemplateBreakdown
      • ITemplateFormat
      • ITemplateFormats
      • Extract Arguments
      • Emplacement
    • Avalanche.Tokenizer
      • Introduction
      • IToken
      • ITokenizer
      • Tokenizers
    • Avalanche.Utilities
      • Introduction
      • Collections
        • Tuples
        • StructList
        • ArrayList
        • BijectionMap
        • LocakableDictionary
        • LockableList
        • MapList
        • Pipe
        • RingQueue
        • EnumerableExtensions
        • TupleUtilities
        • ArrayUtilities
      • Comparers
        • IGraphComparer
        • IGraphComparable
        • AlphaNumericComparer
        • EnumerableComparer
        • EnumerableGraphComparer
        • ReferenceComparer
        • KeyValuePairComparer
        • DefaultComparerProvider
        • RecordComparer
      • Cloners
        • ICloner
        • IGraphCloner
        • IGraphCloneable
        • ListCloner
        • DictionaryCloner
        • FieldCloner
        • PassthroughCloner
        • RecordCloner
        • ClonerProvider
      • Dispose
        • IDisposeAttachable
        • IDisposeBelatable
      • Provider
        • Introduction
        • ProviderBase
        • Delegate
        • Pipe
        • Cache
        • ResultCapture
        • AsReadOnly
        • AsService
        • IProviderEvent
      • Record
        • IRecordDescription
        • IFieldDescription
        • IConstructorDescription
        • IConstructionDescription
        • IParameterDescription
        • IRecordProviders
        • RecordDelegates
          • RecordCreate
          • RecordClone
          • RecordCopy
          • IRecordDelegates
        • FieldDelegates
          • FieldRead
          • FieldWrite
          • RecreateWith
          • IFieldDelegates
      • String
        • IEscaper
        • UnicodeString
      • Miscellaneous
        • IIdGenerator
        • Permutation
        • IReadOnly
        • IUserDataContainer
        • Void
    • Avalanche.Writer
      • Introduction
      • ConstantWriter
      • Context
      • ConvertWriter
      • DefaultConstructor
      • DelegateWriter
      • PassthroughWriter
      • Referer
      • TypeCast
      • Writer
      • WriterPipe
      • WriterMessages

    IEntry

    IEntry is root interface entry interfaces.

    /// <summary>
    /// Entry that represents a node of a <see cref="IFileSystem"/>.
    /// 
    /// The entry represents the snapshot state at the time of creation.
    /// 
    /// See <see cref="IEntry"/> sub-interfaces:
    /// <list type="bullet">
    ///     <item><see cref="IFileEntry"/></item>
    ///     <item><see cref="IDirectoryEntry"/></item>
    ///     <item><see cref="IDriveEntry"/></item>
    ///     <item><see cref="IMountEntry"/></item>
    ///     <item><see cref="IEntryOptions"/></item>
    ///     <item><see cref="IEntryFileAttributes"/></item>
    ///     <item><see cref="IEntryPhysicalPath"/></item>
    ///     <item><see cref="IEntryDecoration"/></item>
    /// </list>
    /// </summary>
    public interface IEntry
    {
        /// <summary>Associated file system.</summary>
        IFileSystem? FileSystem { get; }
        /// <summary>Path relative to the <see cref="IFileSystem"/>. Separator is forward slash "/". Directories end with "/" unless root directory.</summary>
        string Path { get; }
        /// <summary>Entry name in its parent context. All characters are legal, including control characters, except forward slash '/'.</summary>
        string Name { get; }
        /// <summary>Date time of last modification. In UTC time, if possible. If Unknown returns <see cref="DateTimeOffset.MinValue"/>.</summary>
        DateTimeOffset LastModified { get; }
        /// <summary>Last access time of entry. If Unknown returns <see cref="DateTimeOffset.MinValue"/>.</summary>
        DateTimeOffset LastAccess { get; }
    }
    

    IFileEntry is interface file entries.

    /// <summary>File entry</summary>
    public interface IFileEntry : IEntry
    {
        /// <summary>Tests if entry represents a file.</summary>
        bool IsFile { get; }
        /// <summary>File length. -1 if is length is unknown.</summary>
        long Length { get; }
    }
    

    IDirectoryEntry is interface directory entries.

    /// <summary>Directory entry that can be browsed for contents with <see cref="IFileSystemBrowse"/>.</summary>
    public interface IDirectoryEntry : IEntry
    {
        /// <summary>Tests whether entry represents a directory.</summary>
        bool IsDirectory { get; }
    }
    

    IDriveEntry is interface for drive entries.

    /// <summary>
    /// Drive or volume entry. 
    /// 
    /// If drive class is browsable, then the implementation also implements <see cref="IDirectoryEntry"/>.
    /// </summary>
    public interface IDriveEntry : IEntry
    {
        /// <summary>Tests whether entry represents a drive or volume.</summary>
        bool IsDrive { get; }
        /// <summary>Drive type.</summary>
        DriveType DriveType { get; }
        /// <summary>Free space, -1L if unknown.</summary>
        long DriveFreeSpace { get; }
        /// <summary>Total size of drive or volume. -1L if unknown.</summary>
        long DriveSize { get; }
        /// <summary>Label if known</summary>
        string? DriveLabel { get; }
        /// <summary>File system format, e.g. "NTFS", "FAT32".</summary>
        string? DriveFormat { get; }
    }
    

    IMountEntry is interface for mount root directory entries.

    /// <summary>Entry represents a mount point (decoration or virtual filesystem directory).</summary>
    public interface IMountEntry : IEntry
    {
        /// <summary>Does directory represent a mount point.</summary>
        bool IsMountPoint { get; }
        /// <summary>Manually mounted filesystem(s).</summary>
        FileSystemAssignment[] Mounts { get; }
    }
    

    IEntryDecoration is interface for decoration implementations.

    /// <summary>Optional interface that exposes decoree.</summary>
    public interface IEntryDecoration : IEntry
    {
        /// <summary>Original entry that is being decorated.</summary>
        IEntry? Original { get; }
    }
    

    IEntryOptions is interface for entry specific filesystem capability options.

    /// <summary>Entry specific filesystem capability options.</summary>
    public interface IEntryOptions : IEntry
    {
        /// <summary>Options that apply to this entry. The options here are equal or subset of the options in the parenting <see cref="IFileSystem"/>.</summary>
        IOption? Options { get; }
    }
    

    IEntryFileAttributes is interface for entry file attributes.

    /// <summary>Entry file Attributes.</summary>
    public interface IEntryFileAttributes : IEntry
    {
        /// <summary>Has attached <see cref="System.IO.FileAttributes"/>.</summary>
        bool HasFileAttributes { get; }
        /// <summary>File attributes</summary>
        FileAttributes FileAttributes { get; }
    }
    

    IEntryPhysicalPath is interface for entry physical path.

    /// <summary>Optional interface for entries that may have a physical file or directory path.</summary>
    public interface IEntryPhysicalPath : IEntry
    {
        /// <summary>Physical (OS) path to file or directory.</summary>
        string? PhysicalPath { get; }
    }
    

    In This Article
    Back to top Copyright © Toni Kalajainen