Class EncodingMappingConfig

Namespace

Apq.Cfg.EncodingSupport

Assembly

Apq.Cfg.dll

编码映射配置

public sealed class EncodingMappingConfig

Inheritance

object

EncodingMappingConfig

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ReadRules

读取编码映射规则（只读）

public IReadOnlyList<EncodingMappingRule> ReadRules { get; }

Property Value

IReadOnlyList<EncodingMappingRule>

WriteRules

写入编码映射规则（只读）

public IReadOnlyList<EncodingMappingRule> WriteRules { get; }

Property Value

IReadOnlyList<EncodingMappingRule>

Methods

AddReadMapping(string, EncodingMappingType, Encoding, int)

添加读取编码映射规则

public EncodingMappingConfig AddReadMapping(string pattern, EncodingMappingType type, Encoding encoding, int priority = 0)

Parameters

pattern string

匹配模式

type EncodingMappingType

匹配类型

encoding Encoding

目标编码

priority int

优先级（数值越大优先级越高）

Returns

EncodingMappingConfig

AddReadMapping(string, Encoding, int)

添加读取编码映射（完整路径）

public EncodingMappingConfig AddReadMapping(string filePath, Encoding encoding, int priority = 0)

Parameters

filePath string

encoding Encoding

priority int

Returns

EncodingMappingConfig

AddWriteMapping(string, EncodingMappingType, Encoding, int)

添加写入编码映射规则

public EncodingMappingConfig AddWriteMapping(string pattern, EncodingMappingType type, Encoding encoding, int priority = 0)

Parameters

pattern string

匹配模式

type EncodingMappingType

匹配类型

encoding Encoding

目标编码

priority int

优先级（数值越大优先级越高）

Returns

EncodingMappingConfig

AddWriteMapping(string, Encoding, int)

添加写入编码映射（完整路径）

public EncodingMappingConfig AddWriteMapping(string filePath, Encoding encoding, int priority = 0)

Parameters

filePath string

encoding Encoding

priority int

Returns

EncodingMappingConfig

Clear()

清除所有映射规则

public EncodingMappingConfig Clear()

Returns

EncodingMappingConfig

ClearReadMappings()

清除所有读取映射规则

public EncodingMappingConfig ClearReadMappings()

Returns

EncodingMappingConfig

ClearWriteMappings()

清除所有写入映射规则

public EncodingMappingConfig ClearWriteMappings()

Returns

EncodingMappingConfig

GetReadEncoding(string)

获取文件的读取编码

public Encoding? GetReadEncoding(string filePath)

Parameters

filePath string

文件路径

Returns

Encoding

匹配的编码，如果没有匹配则返回 null

GetStats()

获取统计信息

public (int ReadRuleCount, int WriteRuleCount) GetStats()

Returns

(int ReadRuleCount, int WriteRuleCount)

GetWriteEncoding(string)

获取文件的写入编码

public Encoding? GetWriteEncoding(string filePath)

Parameters

filePath string

文件路径

Returns

Encoding

匹配的编码，如果没有匹配则返回 null

RemoveReadMapping(string, EncodingMappingType?)

移除读取编码映射规则

public EncodingMappingConfig RemoveReadMapping(string pattern, EncodingMappingType? type = null)

Parameters

pattern string

匹配模式

type EncodingMappingType?

匹配类型（可选，不指定则移除所有匹配的模式）

Returns

EncodingMappingConfig

RemoveWriteMapping(string, EncodingMappingType?)

移除写入编码映射规则

public EncodingMappingConfig RemoveWriteMapping(string pattern, EncodingMappingType? type = null)

Parameters

pattern string

匹配模式

type EncodingMappingType?

匹配类型（可选，不指定则移除所有匹配的模式）

Returns

EncodingMappingConfig