Static files
Technical reference of Archivos estáticos.
This API is used in Static files.
Symbols
| Symbol | Class | Description |
|---|---|---|
| StaticConfig | type | StaticConfig defines a public type of API. |
| CompressionConfig | type | CompressionConfig defines a public type of API. |
| CompressionAlgorithmConfig | type | CompressionAlgorithmConfig defines a public type of API. |
| DefaultStaticCompressionConfig | func | Returns the default configuration for static files. |
| DefaultHTTPCompressionConfig | func | Returns the default configuration for HTTP responses. |
| Headers | type | Headers defines a public type of API. |
| StaticHeaderRule | type | StaticHeaderRule defines a public type of API. |
| StaticRangeRule | type | StaticRangeRule defines a public type of API. |
StaticConfig
Declaration:
type StaticConfig struct {
Path string
StreamMinFileSize int64
Compression CompressionConfig
Headers []StaticHeaderRule
Range []StaticRangeRule
}StaticConfig defines a public type of API.
Fields
| Field | Type | Description |
|---|---|---|
Path | string | Route used. |
StreamMinFileSize | int64 | Size in bytes. |
Compression | CompressionConfig | Public data associated with Compression. |
Headers | []StaticHeaderRule | Header collection. |
Range | []StaticRangeRule | Public data associated with Range. |
CompressionConfig
Declaration:
type CompressionConfig struct {
Enabled bool
OrderPriority []string
Gzip CompressionAlgorithmConfig
Brotli CompressionAlgorithmConfig
Deflate CompressionAlgorithmConfig
Zstd CompressionAlgorithmConfig
}CompressionConfig defines a public type of API.
Fields
| Field | Type | Description |
|---|---|---|
Enabled | bool | Activate or disable the function. |
OrderPriority | []string | Public data associated with OrderPriority. |
Gzip | CompressionAlgorithmConfig | Public data associated with Gzip. |
Brotli | CompressionAlgorithmConfig | Public data associated with Brotli. |
Deflate | CompressionAlgorithmConfig | Public data associated with Deflate. |
Zstd | CompressionAlgorithmConfig | Public data associated with Zstd. |
CompressionAlgorithmConfig
Declaration:
type CompressionAlgorithmConfig struct {
Enabled bool
Level int
}CompressionAlgorithmConfig defines a public type of API.
Fields
| Field | Type | Description |
|---|---|---|
Enabled | bool | Activate or disable the function. |
Level | int | Public data associated with Level. |
DefaultStaticCompressionConfig
Declaration:
func DefaultStaticCompressionConfig() CompressionConfigReturns the default configuration for static files.
Returns
| Return | Type | Description |
|---|---|---|
value | CompressionConfig | Type value CompressionConfig produced by the operation. |
Usage syntax
value := server.DefaultStaticCompressionConfig()DefaultHTTPCompressionConfig
Declaration:
func DefaultHTTPCompressionConfig() CompressionConfigReturns the default configuration for HTTP responses.
Returns
| Return | Type | Description |
|---|---|---|
value | CompressionConfig | Type value CompressionConfig produced by the operation. |
Usage syntax
value := server.DefaultHTTPCompressionConfig()Headers
Declaration:
type Headers map[string]stringHeaders defines a public type of API.
StaticHeaderRule
Declaration:
type StaticHeaderRule struct {
Match string
Headers Headers
}StaticHeaderRule defines a public type of API.
Fields
| Field | Type | Description |
|---|---|---|
Match | string | Result or expression of coincidence. |
Headers | Headers | Header collection. |
StaticRangeRule
Declaration:
type StaticRangeRule struct {
Match string
Enabled bool
MinFileSize int64
MaxChunkSize int64
}StaticRangeRule defines a public type of API.
Fields
| Field | Type | Description |
|---|---|---|
Match | string | Result or expression of coincidence. |
Enabled | bool | Activate or disable the function. |
MinFileSize | int64 | Size in bytes. |
MaxChunkSize | int64 | Size in bytes. |