Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wickwirew/runtime
A Swift Runtime library for viewing type info, and the dynamic getting and setting of properties.
https://github.com/wickwirew/runtime
ios reflection runtime swift swift4
Last synced: 29 days ago
JSON representation
A Swift Runtime library for viewing type info, and the dynamic getting and setting of properties.
- Host: GitHub
- URL: https://github.com/wickwirew/runtime
- Owner: wickwirew
- License: mit
- Created: 2017-11-04T02:13:17.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-06-04T13:03:55.000Z (5 months ago)
- Last Synced: 2024-06-07T00:56:20.219Z (5 months ago)
- Topics: ios, reflection, runtime, swift, swift4
- Language: Swift
- Homepage:
- Size: 969 KB
- Stars: 1,063
- Watchers: 21
- Forks: 94
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](#cocoapods)
[](http://doge.mit-license.org)
Runtime is a Swift library to give you more runtime abilities, including getting type metadata, setting properties via reflection, and type construction for native swift objects.
## TypeInfo
`TypeInfo` exposes metadata about native Swift structs, protocols, classes, tuples and enums. It captures the properties, generic types, inheritance levels, and more.
### Example
Lets say you have a User struct:
```swift
struct User {
let id: Int
let username: String
let email: String
}
```
To get the `TypeInfo` of `User`, all that you have to do is:
```swift
let info = try typeInfo(of: User.self)
```
## Property Info
Within the `TypeInfo` object, it contains a list of `PropertyInfo` which represents all properties for the type. `PropertyInfo` exposes the name and type of the property. It also allows the getting and setting of a value on an object.
### Example
Using the same `User` object as before first we get the `TypeInfo` and the property we want.
```swift
let info = try typeInfo(of: User.self)
let property = try info.property(named: "username")
```
To get a value:
```swift
let username = try property.get(from: user)
```
To set a value:
```swift
try property.set(value: "newUsername", on: &user)
```
It's that easy! 🎉
## Factory
Runtime also supports building an object from it's `Type`. Both structs and classes are supported.
To build a `User` object:
```swift
let user = try createInstance(type: User.self)
```
## Function Info
`FunctionInfo` exposes metadata about functions. Including number of arguments, argument types, return types, and whether it can throw an error.
### Example
```swift
func doSomething(a: Int, b: Bool) throws -> String {
return ""
}
let info = functionInfo(of: doSomething)
```
## FAQ
Q: When getting and setting a value does it work typeless? (i.e. object casted as `Any`)
A: Yes! The whole library was designed with working typeless in mind.
Q: When creating a new instance of a class is it still protected by ARC?
A: Yes! The retain counts are set properly so ARC can do its job.
## Installation
### Cocoapods
Runtime is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:
```ruby
pod 'Runtime'
```
### Swift Package Manager
You can install Runtime via [Swift Package Manager](https://swift.org/package-manager/) by adding the following line to your `Package.swift`:
```swift
import PackageDescription
let package = Package(
[...]
dependencies: [
.Package(url: "https://github.com/wickwirew/Runtime.git", majorVersion: XYZ)
]
)
```
## Contributions
Contributions are welcome and encouraged!
## Learn
Want to know how it works?
[Here's an article](https://medium.com/@weswickwire/creating-a-swift-runtime-library-3cc92fc486cc) on how it was implemented.
Want to learn about Swift memory layout?
[Mike Ash](https://github.com/mikeash) gave and awesome [talk](https://academy.realm.io/posts/goto-mike-ash-exploring-swift-memory-layout/) on just that.
## License
Runtime is available under the MIT license. See the LICENSE file for more info.