This package is written to compile with gomobile to supported platforms.

Some exported signatures are slightly different than idiomatic Go, since they are meant to be called from linked languages.

sdk.go and gomobile.go documents most of the significant signature elements.

errors.go is an implementation of better error logging proposal X. We follow this error pattern in all exported types and goroutine roots to make error and crash logging easier on linked platforms.

This is the same concurrency guidelines as the connect package.

• Non-view objects should be written to be concurrently accessed, except: -- Read-only data objects -- View object (e.g. view controllers) that assume a single main thread access -- Any object that assumes a single thread ownership, which must be clearly documented

$BRINGYOUR_HOME/bringyour/clientgo install golang.org/x/mobile/cmd/gomobile@latest
$BRINGYOUR_HOME/bringyour/clientgo gomobile init

If you're seeing an error similar to go: error reading go.mod: missing module declaration, then check the project modules with the command go list -m -json all. Likely there is some module that can't be resolved correctly.

Due to a bug in recent versions of Go wrt gomobile, we need to use a patched version of go to build the sdk. See golang/go#68760

git clone https://go.googlesource.com/go
cd go
git checkout release-branch.go1.23
git revert 3560cf0afb3c29300a6c88ccd98256949ca7a6f6
cd src
./make.bash
cd ../..
sudo mv /usr/local/go /usr/local/go.bak
sudo cp -r go /usr/local/go
# now `which go` should point to the patched go

If you see this error, run the following command.

# gomobile: -target="ios/arm64,iossimulator/arm64,macos/arm64,macos/amd64" requires Xcode
sudo xcode-select -s /Applications/Xcode.app/Contents/Developer/