SwiftStorage

https://iroiro.dev/SwiftStorage/documentation/
Admin
SwiftStorage is a Swift macro framework for automatic property persistence and observation, enabling...
Tokens:1,611
Snippets:17
Trust Score:6.5
Update:6 months ago
Show doc for...
Tokens:
Raw
### Using Transient() Macro

Source: https://iroiro.dev/SwiftStorage/documentation/swiftstorage/transient%28%29

Apply the @Transient() macro to properties that should not be persisted. This example shows how to mark a boolean property as non-persistent within a Storage class.

```swift
@Storage
final class SomeClass {
    @Transient
    var someValue: Bool


    init() {
        self.someValue = false
    }
}

```

--------------------------------

### Storage Macro Usage

Source: https://iroiro.dev/SwiftStorage/documentation/swiftstorage/storage%28%29

Demonstrates how to apply the Storage macro to a class and its expanded form.

```APIDOC
## Storage Macro

### Description
The `@Storage` macro is designed to adapt persistence and observation to properties within a class. It can be applied to class members and attributes, and also allows for conforming the class to the `Observable` protocol.

### Usage
Apply the `@Storage` macro to your class definition.

```swift
@Storage
final class SomeClass {
    var someValue: Bool

    init() {
        self.someValue = false
    }
}
```

### Expanded Code
When the `@Storage` macro is expanded, it generates additional properties and methods to handle observation and persistence, including `@LocalStorageProperty`, `ObservationRegistrar`, and methods like `access` and `withMutation`.

```swift
final class SomeClass {
    @LocalStorageProperty
    var someValue: Bool

    init() {
        self.someValue = false
    }

    @Transient private let _$observationRegistrar = Observation.ObservationRegistrar()

    internal nonisolated func access<Member>(
        keyPath: KeyPath<SomeClass, Member>
    ) {
        _$observationRegistrar.access(self, keyPath: keyPath)
    }

    internal nonisolated func withMutation<Member, MutationResult>(
        keyPath: KeyPath<SomeClass, Member>,
        _ mutation: () throws -> MutationResult
    ) rethrows -> MutationResult {
        try _$observationRegistrar.withMutation(of: self, keyPath: keyPath, mutation)
    }

    @Transient private let className = "SomeClass"
}
```

### Transient Properties
Use the `@Transient` macro for properties that should not be preserved. Alternatively, the `ObservationTracked` macro can be used.
```

--------------------------------

### Applying Storage() Macro to a Class

Source: https://iroiro.dev/SwiftStorage/documentation/swiftstorage/storage%28%29

Demonstrates how to apply the @Storage macro to a class to enable persistence and observation for its properties.

```swift
@Storage
final class SomeClass {
    var someValue: Bool


    init() {
        self.someValue = false
    }
}
```

--------------------------------

### SwiftStorage Macros

Source: https://iroiro.dev/SwiftStorage/documentation/swiftstorage

Overview of the available macros in the SwiftStorage framework for managing class properties.

```APIDOC
## SwiftStorage Macros

### Description
Macros provided by the SwiftStorage framework to adapt persistence and observation to properties in a class.

### Macros
- **Attribute(key: String)**: Macro to set a key to associate the value.
- **LocalStorageProperty()**: Macro for specifying the property whose value is to be persisted.
- **Storage()**: Macros to adapt persistence and observation to properties in a class.
- **Transient()**: Macro for specifying properties that are not observed and persisted.
```

--------------------------------

### Expanded Storage() Macro Implementation

Source: https://iroiro.dev/SwiftStorage/documentation/swiftstorage/storage%28%29

Shows the code generated by the @Storage macro when applied to a class, including added properties and methods for observation and persistence.

```swift
final class SomeClass {
    @LocalStorageProperty
    var someValue: Bool


    init() {
        self.someValue = false
    }


    @Transient private let _$observationRegistrar = Observation.ObservationRegistrar()


    internal nonisolated func access<Member>(
        keyPath: KeyPath<SomeClass, Member>
    ) {
        _$observationRegistrar.access(self, keyPath: keyPath)
    }


    internal nonisolated func withMutation<Member, MutationResult>(
        keyPath: KeyPath<SomeClass, Member>,
        _ mutation: () throws -> MutationResult
    ) rethrows -> MutationResult {
        try _$observationRegistrar.withMutation(of: self, keyPath: keyPath, mutation)
    }

    @Transient private let className = "SomeClass"
}
```

--------------------------------

### Storage() Macro Declaration

Source: https://iroiro.dev/SwiftStorage/documentation/swiftstorage/storage%28%29

This is the declaration of the Storage() macro, specifying its attached members and conformances.

```swift
@attached(member, names: named(_$id), named(_$observationRegistrar), named(access), named(withMutation), named(className), named(store)) @attached(memberAttribute) @attached(extension, conformances: Observable) macro Storage()
```

--------------------------------

### Using Attribute Macro for Value Association

Source: https://iroiro.dev/SwiftStorage/documentation/swiftstorage/attribute%28key%3A%29

Demonstrates how to use the @Attribute macro to associate a key with a property in a Swift class. Ensure the class is marked with @Storage.

```swift
@Storage
final class SomeClass {
    @Attribute(key: "SomeValue")
    var someValue: Bool


    init() {
        self.someValue = false
    }
}

```

--------------------------------

### Define LocalStorageProperty macro

Source: https://iroiro.dev/SwiftStorage/documentation/swiftstorage/localstorageproperty%28%29

This macro is attached to properties to handle persistence. It is automatically managed by the Storage macro and should not be manually applied.

```swift
@attached(accessor, names: named(init), named(get), named(set), named(_modify)) @attached(peer, names: prefixed(`_`))
macro LocalStorageProperty()
```

--------------------------------

### @Transient Macro Usage

Source: https://iroiro.dev/SwiftStorage/documentation/swiftstorage/transient%28%29

Defines how to apply the @Transient macro to properties within a class marked with @Storage to exclude them from persistence.

```APIDOC
## @Transient()

### Description
A macro used to specify properties that are not observed and persisted. It is an attached accessor macro named 'willSet'.

### Usage
Apply the @Transient attribute to any property within a class annotated with @Storage that should be excluded from the persistence layer.

### Example
```swift
@Storage
final class SomeClass {
    @Transient
    var someValue: Bool

    init() {
        self.someValue = false
    }
}
```
```

--------------------------------

### Transient() Macro Declaration

Source: https://iroiro.dev/SwiftStorage/documentation/swiftstorage/transient%28%29

Declare the Transient() macro for use in Swift code.

```swift
@attached(accessor, names: named(willSet))
macro Transient()

```

--------------------------------

### Attribute Macro

Source: https://iroiro.dev/SwiftStorage/documentation/swiftstorage/attribute%28key%3A%29

The @Attribute macro allows you to attach a string key to a property, which can be used for various purposes like data storage or identification.

```APIDOC
## @Attribute(key: String)

### Description
Macro to set a key to associate the value.

### Method
Attached Macro

### Endpoint
N/A (Swift Macro)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```swift
@Attribute(key: "SomeValue")
var someValue: Bool
```

### Response
N/A (Compile-time macro)
```

--------------------------------

### Attribute Macro Declaration

Source: https://iroiro.dev/SwiftStorage/documentation/swiftstorage/attribute%28key%3A%29

Declares the Attribute macro, which takes a String key as a parameter. This macro is used to associate values with specific keys.

```swift
@attached(peer)
macro Attribute(key: String)

```
Tokens:
Raw