Class FileChecksumOptions

Namespace

Cuemon.Data.Integrity

Assembly

Cuemon.Data.Integrity.dll

Configuration options for FileInfo.

public class FileChecksumOptions : FileInfoOptions, IParameterObject

Inheritance

object

FileInfoOptions

FileChecksumOptions

Implements

IParameterObject

Inherited Members

FileInfoOptions.BytesToRead

Examples

The following example shows how to configure FileChecksumOptions and create cache validators with different integrity methods for a file. It demonstrates default settings, combined validation, and strong validation with a limited byte read.

using System;
using System.IO;
using Cuemon.Data.Integrity;

namespace MyApp.Data
{
    public sealed class FileChecksumOptionsExample
    {
        public void Demonstrate()
        {
            var defaults = new FileChecksumOptions();
            Console.WriteLine($"Default method: {defaults.Method}");
            Console.WriteLine($"Default bytes to read: {defaults.BytesToRead}");

            var path = Path.Combine(AppContext.BaseDirectory, "payload.txt");
            File.WriteAllText(path, "cuemon");

            try
            {
                var file = new FileInfo(path);

                var combinedValidator = CacheValidatorFactory.CreateValidator(file, setup: options =>
                {
                    options.Method = EntityDataIntegrityMethod.Combined;
                });

                var strongValidator = CacheValidatorFactory.CreateValidator(file, setup: options =>
                {
                    options.BytesToRead = 4;
                });

                Console.WriteLine($"Combined method: {combinedValidator.Method}");
                Console.WriteLine($"Strong validation: {strongValidator.Validation}");
            }
            finally
            {
                if (File.Exists(path)) { File.Delete(path); }
            }
        }
    }
}

Constructors

FileChecksumOptions()

Initializes a new instance of the FileChecksumOptions class.

public FileChecksumOptions()

Remarks

The following table shows the initial property values for an instance of FileChecksumOptions.

Property	Initial Value
Method	Unaltered

Properties

Method

Gets an enumeration value of EntityDataIntegrityMethod indicating how a checksum is generated.

public EntityDataIntegrityMethod Method { get; set; }

Property Value

EntityDataIntegrityMethod

One of the enumeration values of EntityDataIntegrityMethod that indicates how a checksum is generated.