DiskConfig class
Configuration for a filesystem disk.
- Annotations
-
- @immutable
Constructors
-
DiskConfig({required String driver, String? root, String? url, String? visibility, bool throw_ = false, bool report = false, String directorySeparator = '/', String? prefix, bool readOnly = false, Map<
String, dynamic> options = const {}}) -
Creates a new disk configuration.
const
-
DiskConfig.fromMap(Map<
String, dynamic> map) -
Create a DiskConfig from a map
factory
Properties
- directorySeparator → String
-
Directory separator character
final
- driver → String
-
The driver type (e.g., 'local', 's3', 'gcs')
final
- hashCode → int
-
The hash code for this object.
no setteroverride
- isS3 → bool
-
Check if this is an S3-compatible driver
no setter
-
options
→ Map<
String, dynamic> -
Additional driver-specific options
final
- prefix → String?
-
Path prefix for scoped disks
final
- readOnly → bool
-
Whether the disk is read-only
final
- report → bool
-
Whether to report exceptions
final
- root → String?
-
The root path for the disk
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- s3AccessKey → String?
-
Get S3 access key from options
no setter
- s3Bucket → String?
-
Get S3 bucket from options
no setter
- s3Endpoint → String?
-
Get S3 endpoint from options
no setter
- s3Port → int?
-
Get S3 port
no setter
- s3Region → String?
-
Get S3 region from options
no setter
- s3SecretKey → String?
-
Get S3 secret key from options
no setter
- s3SessionToken → String?
-
Get S3 session token (for temporary credentials)
no setter
- s3UseSSL → bool
-
Get S3 use SSL setting
no setter
- throw_ → bool
-
Whether to throw exceptions on errors
final
- url → String?
-
The public URL for the disk
final
- visibility → String?
-
Default visibility for files
final
Methods
-
copyWith(
{String? driver, String? root, String? url, String? visibility, bool? throw_, bool? report, String? directorySeparator, String? prefix, bool? readOnly, Map< String, dynamic> ? options}) → DiskConfig - Create a copy with updated values
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> - Convert to a map
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override