# cgo-rs

[![](https://img.shields.io/crates/v/cgo.svg)](https://crates.io/crates/cgo)

A library for build scripts to compile custom Go code, inspired by the
excellent [cc](https://docs.rs/cc/latest/cc) crate.

It is intended that you use this library from within your `build.rs` file by
adding the cgo crate to your [`build-dependencies`](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#build-dependencies):

```toml
[build-dependencies]
cgo_oligami = "*"
```

# Examples

The following example will statically compile the Go package and instruct
cargo to link the resulting library (`libexample`).

```rust
fn main() {
    cgo::Build::new()
        .package("pkg/example/main.go")
        .build("example");
}
```

# windows cannot support
Golang is not support llvm on windows so Rust cannot link Golang staticlib on windows
https://github.com/golang/go/issues/17014
If you use, dynamiclib
https://doc.rust-lang.org/reference/items/external-blocks.html#the-link-attribute

# support
mac and linux without alpine

# memo
https://zenn.dev/koya_iwamura/articles/bb9b590b57d825
https://tip.golang.org/doc/go1.21#go-command

# Minimum Version
- rust 1.64 <br>
- go 1.21.1