gurs_core

README

Gurs Core

[!WARNING]
Still on development ... 🚧

🏴 Languages

• Español
• Русский
• Galego

Prerequisites for use:

• Go
• Cargo
• CGo (only in project)

🤯 What is gurs-core ?

Library that parses rust code & create an interface to use on your golang projects (intended to be used by a cli running on windows/linux/osx):

• Using https://wazero.io/ [Needs to compile to Webassembly].

• Using DLL / SO / LYB (System Dependent Libraries, which can be loaded without a package) [Requires using rustc commands]. (Create Rust DLL) https://samrambles.com/guides/window-hacking-with-rust/creating-a-dll-with-rust/index.html#hellodll (Load DLL go // Possible Option) https://github.com/ebitengine/purego

• Using CGo: (Compile Rust to C library and generate .h) https://github.com/mozilla/cbindgen [Example of use] https://github.com/getsentry/milksnake

Use text/template to have a template with golang code that will be embedded in the build of the package and that at runtime will substitute the necessary values to make it run according to the options chosen later in the cli

More Documentation:

• Rust with C: https://docs.rust-embedded.org/book/interoperability/rust-with-c.html#no_mangle
• Rust struct methods with C: https://stackoverflow.com/questions/54156498/how-to-call-a-rust-structs-method-from-c-using-ffi
• How to use C libraries in Go with CGo: https://dev.to/metal3d/understand-how-to-use-c-libraries-in-go-with-cgo-3dbn
• Specify Rust build target: https://doc.rust-lang.org/cargo/reference/config.html#buildtarget

OS Support

Windows	Linux	MacOS	FreeBSD
✔	✔	✔	❓

Documentation

Overview

🦀 Rust code parser & type-safe interface for Golang. ✨

Index

• func ExploreFolder(folderPath string) ([]string, error)
• func GetFunctions(filePaths []string) []parser.Rustfn
• type Gofunc
  • func ConvertRsFnSliceToGo(fns *[]parser.Rustfn) (goFuncs []Gofunc)

Functions

func ExploreFolder

func ExploreFolder(folderPath string) ([]string, error)

ExploreFolder gets the rootFolder path and returns the filePath of all the .rs files located on the folder

func GetFunctions

func GetFunctions(filePaths []string) []parser.Rustfn

GetFunctions parse the files according to the slice of filePaths from the arguments. It returns an slice of Rustfn(structs) that stores the name, parameter (with types) & the returned values (with types)

Types

type Gofunc

type Gofunc = parser.Gofunc

func ConvertRsFnSliceToGo

func ConvertRsFnSliceToGo(fns *[]parser.Rustfn) (goFuncs []Gofunc)

ConvertRsFnSliceToGo gets an slice of RustFn and returns the corresponding transpilation to Gofunc slice. For individual implementation is a Rustfn struct method (Rustfn -> Gofunc)